initial docs commit

This commit is contained in:
Charlie Root 2019-04-25 00:55:20 +00:00
commit e459989228
3 changed files with 24 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
site

17
docs/index.md Normal file
View File

@ -0,0 +1,17 @@
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://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 help` - Print this help message.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

6
mkdocs.yml Normal file
View File

@ -0,0 +1,6 @@
site_name: Tilde Black Documentation
nav:
- Home: index.md
- About: about.md
theme: readthedocs
site_dir: /var/www/htdocs/docs/