Skip to content

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.

Notifications You must be signed in to change notification settings

sakim/GitHub-Wikifier

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 

Repository files navigation

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

How to use

  1. Clone your wiki git repo

    https://github.com/hybridgroup/GitHub-Wikifier/wiki/_access

  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

About

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.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%