@grafana/api-documenter
Advanced tools
Read JSON files from api-extractor, generate documentation pages
This tool can be used to generate an online API reference manual for your TypeScript library. It reads the *.api.json data files produced by API Extractor, and then generates files in Markdown or DocFX format.
For usage information, see the Generating Docs article from the API Extractor documentation.
API documentation for this package: https://rushstack.io/pages/api/api-documenter/
When running the tool with the markdown option you can specify two more flags:
--hugo that will export the markdown in a hugo friendly format with FrontMatter meta data included.--draft that will make the documentation as draft (it will not be visible when running Hugo in production).FAQs
Read JSON files from api-extractor, generate documentation pages
The npm package @grafana/api-documenter receives a total of 217 weekly downloads. As such, @grafana/api-documenter popularity was classified as not popular.
We found that @grafana/api-documenter demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.