Skip to content
This repository has been archived by the owner on Apr 13, 2023. It is now read-only.
/ SkyDocs Public archive

SkyDocs is a lightweight static documentation builder with MarkDown.

License

Notifications You must be signed in to change notification settings

Skyost/SkyDocs

Repository files navigation

SkyDocs

SkyDocs is a lightweight static documentation builder with MarkDown.

Libraries.io for GitHub CircleCI license GitHub (pre-)release

Overview

SkyDocs is a software that takes your MarkDown files and build a complete website with some magic tricks !
You can configure everything you want : themes, pages, menus, ...

Features

  • Lightweight
  • Cross-system (you need Java)
  • Write your documentation in MarkDown
  • Use jtwig template engine
  • Host it anywhere : it's static !
  • Responsive and HTML5 valid theme provided
  • Generate a multi-language documentation
  • Fast building
  • Automatically minifies HTML, CSS and JS files in production mode
  • A lot more !

Documentation

Everything you need to know is available on the website.

Download

If you are interested, you can download SkyDocs on this page. You can also read the software's review on Softpedia.

Contributions

There are some options if you would like to contribute to this project. You can follow its advancement, star it (it helps having better visibility) or fork it on Github.

Oh and if you really like this project, please consider making a donation. I would really appreciate it.