enlightme
v0.2.0
Published
Enlighten your users with a beautiful documentation
Downloads
1,467
Readme
Enlight'me
Enlighten your users with a beautiful documentation
Enlight'me is a static site generator based on Metalsmith that let you
build pretty Github pages for your projects without hassles. Just put some Markdown
files in a doc/
folder of your repo, and you'r done!
Install
To install Enlight'me, run the following command:
npm install --save-dev enlightme
Documentation
- See https://wanadev.github.io/enlightme/
Contributing
Questions
If you have any question, you can:
Bugs
If you found a bug, please open an issue on Github with as much information as possible.
Pull Requests
Please consider filing a bug before starting to work on a new feature. This will allow us to discuss the best way to do it. This is of course not necessary if you just want to fix some typo or small errors in the code.
Codding Style / Lint
To check codding style, run the follwoing command:
npm run lint
Changelog
[NEXT] (changes on master that have not been released yet):
- Nothing yet ;)
v0.2.0:
- Added a lint command in package.json (@flozz)
- Fixed wrong dependencies: added missing lodash, and removed unnecessary request lib (@jbghoul, #7)
- Updated dependencies (@jbghoul, #7)
v0.1.1:
- Fixed a syntax error in a template (@flozz)
v0.1.0:
- Initial release