enlightme
Advanced tools
Readme
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!
To install Enlight'me, run the following command:
npm install --save-dev enlightme
If you have any question, you can:
If you found a bug, please open an issue on Github with as much information as possible.
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.
To check codding style, run the follwoing command:
npm run lint
[NEXT] (changes on master that have not been released yet):
v0.2.0:
v0.1.1:
v0.1.0:
FAQs
Enlighten your users with a beautiful documentation
We found that enlightme demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.