Browse Source

start off the mkdocs train. add a readme.

Charles Reid 1 year ago
parent
commit
c2eb6351c1
3 changed files with 12 additions and 1 deletions
  1. 2
    0
      .gitignore
  2. 9
    0
      Readme.md
  3. 1
    1
      mkdocs.yml

+ 2
- 0
.gitignore View File

@@ -0,0 +1,2 @@
1
+# ignore mkdocs
2
+site/

+ 9
- 0
Readme.md View File

@@ -0,0 +1,9 @@
1
+# github-heroku-attack-rabbits: secret branch
2
+
3
+The secret branch contains the mkdocs source files
4
+needed to generate the final static content for the 
5
+secret site.
6
+
7
+This is the site that is deployed to Heroku.
8
+
9
+See [https://github-heroku-attack-rabbits.herokuapp.com](https://github-heroku-attack-rabbits.herokuapp.com).

+ 1
- 1
mkdocs.yml View File

@@ -15,7 +15,7 @@ pages:
15 15
 
16 16
 copyright: 'Copyright &copy; 2018 Charles Reid, released under the <a href="https://git.charlesreid1.com/charlesreid1/github-heroku-attack-rabbits/src/branch/master/LICENSE">WTFPL</a>.<br /><br />Many Bothans died to bring us this documentation.<br /><br />'
17 17
 
18
-docs_dir: docs
18
+docs_dir: secret_docs
19 19
 site_dir: site/content
20 20
 
21 21
 theme: