mirror of
https://github.com/tubearchivist/docs.git
synced 2024-11-14 16:10:12 +00:00
add basic project structure
This commit is contained in:
parent
0f11029900
commit
9e959795be
17
mkdocs/docs/index.md
Normal file
17
mkdocs/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.
|
1
mkdocs/mkdocs.yml
Normal file
1
mkdocs/mkdocs.yml
Normal file
@ -0,0 +1 @@
|
|||||||
|
site_name: Tube Archivist Documentation
|
Loading…
Reference in New Issue
Block a user