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.
This commit is contained in:
parent
6226abf2b9
commit
ee39f48a97
17
docs/index.md
Normal file
17
docs/index.md
Normal file
@ -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.
|
4
mkdocs.yml
Normal file
4
mkdocs.yml
Normal file
@ -0,0 +1,4 @@
|
||||
site_name: SelfHost-Hub
|
||||
site_url: https://selfhost-hub.com
|
||||
theme:
|
||||
name: material
|
Loading…
Reference in New Issue
Block a user