From 1858e7b41882fe0b532f58b367f8f0349b54fb3e Mon Sep 17 00:00:00 2001 From: Ben Harris Date: Wed, 20 Nov 2019 12:10:19 -0500 Subject: [PATCH] switch to mkdocs --- .gitignore | 1 + _config.yml | 1 - .../branching_strategies.md | 8 ------ common_commands.md => docs/common_commands.md | 8 ------ glossary.md => docs/glossary.md | 8 ------ {img => docs/img}/add-and-commit.png | Bin {img => docs/img}/gitgud.jpeg | Bin {img => docs/img}/new-repo-status.png | Bin {img => docs/img}/pretty-oneline.png | Bin README.md => docs/index.md | 17 ------------ ssh_setup.md => docs/ssh_setup.md | 8 ------ docs/troubleshooting.md | 17 ++++++++++++ mkdocs.yml | 2 ++ troubleshooting.md | 25 ------------------ 14 files changed, 20 insertions(+), 75 deletions(-) create mode 100644 .gitignore delete mode 100644 _config.yml rename branching_strategies.md => docs/branching_strategies.md (71%) rename common_commands.md => docs/common_commands.md (94%) rename glossary.md => docs/glossary.md (96%) rename {img => docs/img}/add-and-commit.png (100%) rename {img => docs/img}/gitgud.jpeg (100%) rename {img => docs/img}/new-repo-status.png (100%) rename {img => docs/img}/pretty-oneline.png (100%) rename README.md => docs/index.md (92%) rename ssh_setup.md => docs/ssh_setup.md (83%) create mode 100644 docs/troubleshooting.md create mode 100644 mkdocs.yml delete mode 100644 troubleshooting.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..45ddf0a --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +site/ diff --git a/_config.yml b/_config.yml deleted file mode 100644 index fff4ab9..0000000 --- a/_config.yml +++ /dev/null @@ -1 +0,0 @@ -theme: jekyll-theme-minimal diff --git a/branching_strategies.md b/docs/branching_strategies.md similarity index 71% rename from branching_strategies.md rename to docs/branching_strategies.md index c0d665f..152188e 100644 --- a/branching_strategies.md +++ b/docs/branching_strategies.md @@ -1,13 +1,5 @@ # branching strategies -### table of contents -[home](README.md) • -[glossary](glossary.md) • -[common commands](common_commands.md) • -**[branching strategies](branching_strategies.md)** • -[troubleshooting](troubleshooting.md) • -[ssh setup](ssh_setup.md) - --- ## Branch to env mapping diff --git a/common_commands.md b/docs/common_commands.md similarity index 94% rename from common_commands.md rename to docs/common_commands.md index 67144a0..74839a6 100644 --- a/common_commands.md +++ b/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) • -[glossary](glossary.md) • -**[common commands](common_commands.md)** • -[branching strategies](branching_strategies.md) • -[troubleshooting](troubleshooting.md) • -[ssh setup](ssh_setup.md) - --- diff --git a/glossary.md b/docs/glossary.md similarity index 96% rename from glossary.md rename to docs/glossary.md index 8e1674e..2cce947 100644 --- a/glossary.md +++ b/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) • -**[glossary](glossary.md)** • -[common commands](common_commands.md) • -[branching strategies](branching_strategies.md) • -[troubleshooting](troubleshooting.md) • -[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 b/docs/img/add-and-commit.png similarity index 100% rename from img/add-and-commit.png rename to docs/img/add-and-commit.png diff --git a/img/gitgud.jpeg b/docs/img/gitgud.jpeg similarity index 100% rename from img/gitgud.jpeg rename to docs/img/gitgud.jpeg diff --git a/img/new-repo-status.png b/docs/img/new-repo-status.png similarity index 100% rename from img/new-repo-status.png rename to docs/img/new-repo-status.png diff --git a/img/pretty-oneline.png b/docs/img/pretty-oneline.png similarity index 100% rename from img/pretty-oneline.png rename to docs/img/pretty-oneline.png diff --git a/README.md b/docs/index.md similarity index 92% rename from README.md rename to docs/index.md index 4fc3274..02545c8 100644 --- a/README.md +++ b/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)** • -[glossary](glossary.md) • -[common commands](common_commands.md) • -[branching strategies](branching_strategies.md) • -[troubleshooting](troubleshooting.md) • -[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 b/docs/ssh_setup.md similarity index 83% rename from ssh_setup.md rename to docs/ssh_setup.md index 7e5d307..a1a25d2 100644 --- a/ssh_setup.md +++ b/docs/ssh_setup.md @@ -1,13 +1,5 @@ # ssh key setup for git -### table of contents -[home](README.md) • -[glossary](glossary.md) • -[common commands](common_commands.md) • -[branching strategies](branching_strategies.md) • -[troubleshooting](troubleshooting.md) • -**[ssh setup](ssh_setup.md)** - --- diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 0000000..38e0d3c --- /dev/null +++ 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 new file mode 100644 index 0000000..765e47a --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,2 @@ +site_name: learngit +theme: cyborg diff --git a/troubleshooting.md b/troubleshooting.md deleted file mode 100644 index 07764a8..0000000 --- a/troubleshooting.md +++ /dev/null @@ -1,25 +0,0 @@ -# troubleshooting - -### table of contents -[home](README.md) • -[glossary](glossary.md) • -[common commands](common_commands.md) • -[branching strategies](branching_strategies.md) • -**[troubleshooting](troubleshooting.md)** • -[ssh setup](ssh_setup.md) - ---- - - -ssh warnings remote key - -missing branches - -warnings - -line endings - -pull request flow - -ui flow -