From ee39f48a97afa2f68d68740d74ddfe8f90aca455 Mon Sep 17 00:00:00 2001 From: songtianlun Date: Sun, 20 Apr 2025 17:22:33 +0800 Subject: [PATCH] docs: add mkdocs configuration and initial documentation - Introduce mkdocs.yml for site configuration - Create index.md with basic commands and project layout These files are essential for generating and serving project documentation, enhancing accessibility and user experience. --- docs/index.md | 17 +++++++++++++++++ mkdocs.yml | 4 ++++ 2 files changed, 21 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 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/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ef1b2ff --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: SelfHost-Hub +site_url: https://selfhost-hub.com +theme: + name: material