switch to mkdocs

envs-net · Nov 20, 2019 · 1858e7b · 1858e7b
1 parent 4c2e83a
commit 1858e7b
Show file tree

Hide file tree

Showing 14 changed files with 20 additions and 75 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+site/
diff --git a/_config.yml b/_config.yml
diff --git a/branching_strategies.md → docs/branching_strategies.md b/branching_strategies.md → docs/branching_strategies.md
@@ -1,13 +1,5 @@
 # branching strategies
 
-### table of contents
-[home](README.md) &bull;
-[glossary](glossary.md) &bull;
-[common commands](common_commands.md) &bull;
-**[branching strategies](branching_strategies.md)** &bull;
-[troubleshooting](troubleshooting.md) &bull;
-[ssh setup](ssh_setup.md)
-
 ---
 
 ## Branch to env mapping

diff --git a/common_commands.md → docs/common_commands.md b/common_commands.md → docs/common_commands.md
@@ -2,14 +2,6 @@
 
 These are commands and options that I use frequently. See the linked documentation for more options and information.
 
-### table of contents
-[home](README.md) &bull;
-[glossary](glossary.md) &bull;
-**[common commands](common_commands.md)** &bull;
-[branching strategies](branching_strategies.md) &bull;
-[troubleshooting](troubleshooting.md) &bull;
-[ssh setup](ssh_setup.md)
-
 ---
 
 

diff --git a/glossary.md → docs/glossary.md b/glossary.md → docs/glossary.md
@@ -2,14 +2,6 @@
 
 > [source (git-scm.com)](https://git-scm.com/book/en/v2) (unless otherwise noted)
 
-### table of contents
-[home](README.md) &bull;
-**[glossary](glossary.md)** &bull;
-[common commands](common_commands.md) &bull;
-[branching strategies](branching_strategies.md) &bull;
-[troubleshooting](troubleshooting.md) &bull;
-[ssh setup](ssh_setup.md)
-
 ---
 
 ## [branch](https://git-scm.com/book/en/v1/Git-Branching-What-a-Branch-Is)

diff --git a/img/add-and-commit.png → docs/img/add-and-commit.png b/img/add-and-commit.png → docs/img/add-and-commit.png
diff --git a/img/gitgud.jpeg → docs/img/gitgud.jpeg b/img/gitgud.jpeg → docs/img/gitgud.jpeg
diff --git a/img/new-repo-status.png → docs/img/new-repo-status.png b/img/new-repo-status.png → docs/img/new-repo-status.png
diff --git a/img/pretty-oneline.png → docs/img/pretty-oneline.png b/img/pretty-oneline.png → docs/img/pretty-oneline.png
diff --git a/README.md → docs/index.md b/README.md → docs/index.md
@@ -2,25 +2,8 @@
 
 This is a compilation of notes, tips and a getting started guide to [`git`](https://git-scm.com). Please feel free to open a pull request or fork it for yourself!
 
-### table of contents
-**[home](README.md)** &bull;
-[glossary](glossary.md) &bull;
-[common commands](common_commands.md) &bull;
-[branching strategies](branching_strategies.md) &bull;
-[troubleshooting](troubleshooting.md) &bull;
-[ssh setup](ssh_setup.md)
-
 ---
 
-### on this page
-* [getting set up](README.md#getting-set-up)
-* [making your first repo](README.md#making-your-first-repo)
-* [syncing your changes with others](README.md#syncing-your-changes-with-others)
-* [external resources](README.md#external-resources)
-
----
-
-
 # here we go!
 
 This is not meant to be a complete guide to git. Just some notes that I've gathered over the years of using git that might be helpful to share with others.

diff --git a/ssh_setup.md → docs/ssh_setup.md b/ssh_setup.md → docs/ssh_setup.md
@@ -1,13 +1,5 @@
 # ssh key setup for git
 
-### table of contents
-[home](README.md) &bull;
-[glossary](glossary.md) &bull;
-[common commands](common_commands.md) &bull;
-[branching strategies](branching_strategies.md) &bull;
-[troubleshooting](troubleshooting.md) &bull;
-**[ssh setup](ssh_setup.md)**
-
 ---
 
 

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -0,0 +1,17 @@
+# troubleshooting
+
+---
+
+
+ssh warnings remote key
+
+missing branches
+
+warnings
+
+line endings
+
+pull request flow
+
+ui flow
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,2 @@
+site_name: learngit
+theme: cyborg
diff --git a/troubleshooting.md b/troubleshooting.md