imclab / github-wikifier

A pre-commit Git Hook that will generate all the Table of Contents you will ever need. Just write your content, and let it take over.

What is this?

GitHub Wikifier helps you organize your Github Wiki with a set of good practices and autogenerated navigation table. Why should I care?

Demo

See it in action in artoo wiki

Requirements

1. Zsh ( Install via sudo apt-get install zsh or brew install zsh )
2. GNU Utilities ( only for Mac ) via brew install coreutils

How to use

1. Clone your wiki git repo

   https://github.com/yourname/reponame.wiki.git

2. Create directory structure following these guidelines https://github.com/hybridgroup/Github-Wikifier/wiki/1.1.-Naming-Guidelines

3. Run command to install script

   curl -Lo- https://goo.gl/C170k | bash

4. Commit your changes

   git commit -m "$message"

   The script will be triggered parsing files and directories and add generated files to your commit.

5. Push your changes

• It's important that you use git access for your changes from now on.

Contact

• If you need help or you feel we can improve something, let us know! Open a new issue

Participate

• Want to contribute making this better? Check out the open issues or send a pull request.

Maintainers

• Mario Ricalde
• Javier Cervantes