diff --git a/README.md b/README.md index 5bff707..f98ea26 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Install `mkdocs` through pip: ``` # xbps-install -Sy python3-devel python3-pip -$ pip install mkdocs +$ pip install mkdocs mkdocs-material ``` This will put a binary in `~/.local/lib/python3.11/site-packages/mkdocs/__main__.py` @@ -37,4 +37,4 @@ And preview it with: $ mkdocs serve ``` -This will host the website locally on [http://127.0.0.1:8000/](http://127.0.0.1:8000/). \ No newline at end of file +This will host the website locally on [http://127.0.0.1:8000/](http://127.0.0.1:8000/). diff --git a/mkdocs.yml b/mkdocs.yml index c97182f..69d22bf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1 +1,3 @@ site_name: My Docs +theme: + name: material diff --git a/site/404.html b/site/404.html new file mode 100644 index 0000000..a20dd7d --- /dev/null +++ b/site/404.html @@ -0,0 +1,251 @@ + + + +
+ + + + + + + + + + + + + +For full documentation visit mkdocs.org.
+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.mkdocs.yml # The configuration file.
+docs/
+ index.md # The documentation homepage.
+ ... # Other markdown pages, images and other files.
+
+
+
+
+
+
+
+ For full documentation visit mkdocs.org.
"},{"location":"#commands","title":"Commands","text":"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.mkdocs.yml # The configuration file.\ndocs/\n index.md # The documentation homepage.\n ... # Other markdown pages, images and other files.\n
"}]}
\ No newline at end of file
diff --git a/site/sitemap.xml b/site/sitemap.xml
new file mode 100644
index 0000000..0f8724e
--- /dev/null
+++ b/site/sitemap.xml
@@ -0,0 +1,3 @@
+
+