Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.5 KB

README.md

File metadata and controls

41 lines (31 loc) · 1.5 KB

Documatic

Documatic automatically generates beautiful user documentation from markdown files in your repository.

This repo is me playing with various projects that enable creation of documentation automatically.

Table of content

Motivation

Traditional methods of creating documentation often involve running servers or generating static HTML files. Documatic simplifies this process by generating a documentation site directly from your markdown files in your repo, making it easy to keep your documentation up-to-date.

Screenshots

TODO: Screenshots of the app

Installation & Usage

Project is still a work in progress.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

Not released yet.

Credits

License

See the LICENSE file in this project's directory.