kreas / docit

Starter repo for a github based personal knowledge base.

Developer Documentation

Generate Documentation

TODO: Add some documentation about the documentation

---

Table of Contents

• Example

  • About Examples
  • Historical Use of Example Documentation
    • The Dark Ages

• Examples Chapter 2

  • The Endless Sea

Created by gh-md-toc

---

Setup Instructions

Want to write some documentation? Great!

Just run:

cat ./lib/docit.sh > ./.git/hooks/pre-commit
chmod 0755 ./.git/hooks/pre-commit