]> where.june.codes Git - june.codes/commitdiff
projects / june.codes / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 7f4aefc)
Switching to MkDocs.
authorJune Gardner <june@june.codes>
Tue, 26 Aug 2025 17:38:12 +0000 (10:38 -0700)
committerJune Gardner <june@june.codes>
Tue, 26 Aug 2025 17:38:12 +0000 (10:38 -0700)
docs/index.md [new file with mode: 0644] patch | blob
index.html [deleted file] patch | blob | history
mkdocs.yml [new file with mode: 0644] patch | blob

diff --git a/docs/index.md b/docs/index.md
new file mode 100644 (file)
index 0000000..000ea34
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/index.html b/index.html
deleted file mode 100644 (file)
index 58779ef..0000000
--- a/index.html
+++ /dev/null
@@ -1,9 +0,0 @@
-<html>
-    <head>
-        <title>Welcome!</title>
-    </head>
-    <body>
-        <h1>Welcome!</h1>
-        <p>This is a test page.</p>
-    </body>
-</html>
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644 (file)
index 0000000..582b020
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1 @@
+site_name: June Codes
The source code for https://june.codes.