@chisel/fluorite
Advanced tools
Fluorite is an easy-to-use API documentation generator, built to allow rapid development of API documentations (RESTful and other types of APIs) while being flexible in design.
Fluorite encourages modular structures, therefore, the documentation is made of different files grouped together as sections through a JSON configuration file named flconfig.json. Files are either JSON files (for documenting RESTful APIs) or pure Markdown (for other documentations,) all loaded into one or more HTML pages to form the documentation.
Fluorite is also flexible in design through themes. Each theme decides on the documentation layout and can even define extra features using the provided utility libraries, independent of any pre-defined mechanism. You can easily make your own themes using the Handlebars templating language and have your documentations look exactly the same as your website/web app.
npm install @chisel/fluorite -gfl new <name> (example fl new docs)fl serve to build and servehttp://localhost:6001Fluorite is heavily documented using Fluorite! We strongly recommend you to read the official documentation after playing around with Fluorite to fully benefit from its features.
FAQs
An easy-to-use API documentation generator.
We found that @chisel/fluorite demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.
Security News
PEP 770 proposes adding SBOM support to Python packages to improve transparency and catch hidden non-Python dependencies that security tools often miss.
Security News
Socket CEO Feross Aboukhadijeh discusses open source security challenges, including zero-day attacks and supply chain risks, on the Cyber Security Council podcast.