Skip to content
This repository was archived by the owner on Jan 25, 2022. It is now read-only.

Commit 1359398

Browse files
committed
Add README for docs/mkdocs
1 parent a810d4b commit 1359398

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,4 @@
88
/sql/*
99
!/sql/README.sql.md
1010
!/sql/provision.sql
11-
/docs
12-
!/docs/README.docs.md
1311

docs/README.docs.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
This `{project}/docs` directory off the root of this project is where an `mkdocs build`
2+
will generate your HTML+CSS+etc based on the markdown files in `{project}/mkdocs`.
3+
4+
If you want to change the directory where your docs are output, such as to `/www/docs`
5+
you can do that by changing `site_dir:` in `{project}/mkdocs.yml` to be `'www/docs'`
6+
instead of just `'docs'.

0 commit comments

Comments
 (0)