Skip to content

Simple & fast WYSIWYG repo documentation generator with personal enchacements.

License

Notifications You must be signed in to change notification settings

OS-expected/EzGitDoc

Repository files navigation



EzGitDoc logo

Can project documentation be fun to do and then interesting to read by it's users?
EzGitDoc is WYSIWYG "clicking" tool designed to improve Git repositories documentation experience.

Check it by yourself :)



    

1. Personalize look and functionality.

EzGitDoc photo 1 EzGitDoc photo 2

    

2. Quickly redesign template...

EzGitDoc photo 3

    

...and when your template gets more complicated, quickly rearrange or move elements via references section.

EzGitDoc photo 4

    

3. Preview your work at EzGitDoc.

EzGitDoc photo 5

    

4. Generate code and put it onto your readme making final touches.

EzGitDoc photo 6

    

5. Obtain interesting to read outputs.

Project details


EzGitDoc documentation(including quick guide) can be found at:
https://os-expected.github.io/EzGitDoc-documentation/

while the tool is available at:
https://os-expected.github.io/EzGitDoc/.


Thanks to @damianggg for spending time on functional tests 👍

Icon responding for EzGitDoc logo belongs to Font Awesome and is available over here

Loading image source: Loading.io