https://github.com/OS-expected/EzGitDoc

Simple & fast WYSIWYG repo documentation generator with personal enchacements.
https://github.com/OS-expected/EzGitDoc

ezgitdoc github-md html html-to-markdown javascript less markdown markdown-editor markdown-generator mdbootstrap readme-generator readme-template template-generator wysiwyg

Last synced: about 2 months ago
JSON representation

Simple & fast WYSIWYG repo documentation generator with personal enchacements.

• Host: GitHub
• URL: https://github.com/OS-expected/EzGitDoc
• Owner: OS-expected
• License: mit
• Created: 2020-02-26T09:57:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T23:33:08.000Z (about 1 year ago)
• Last Synced: 2024-04-28T02:14:03.518Z (5 months ago)
• Topics: ezgitdoc, github-md, html, html-to-markdown, javascript, less, markdown, markdown-editor, markdown-generator, mdbootstrap, readme-generator, readme-template, template-generator, wysiwyg
• Language: JavaScript
• Homepage: https://os-expected.github.io/EzGitDoc/
• Size: 21.3 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• project-awesome - OS-expected/EzGitDoc - Simple & fast WYSIWYG repo documentation generator with personal enchacements. (JavaScript)

README

        








     



    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. 





    

    




    
2. Quickly redesign template... 





    




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





    




    
3. Preview your work at EzGitDoc. 





    




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





    




    
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