songtianlun
ee39f48a97
- 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.
18 lines
491 B
Markdown
18 lines
491 B
Markdown
# 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.
|