documentalist
Advanced tools
A sort-of-static site generator optimized for living documentation of software projects.
Documentalist comes pre-configured with support for the following languages:
.md files for longform documentation and overall structure.ts, .tsx files for JSDoc comments on interfaces in TypeScript source code.css, .scss files for comments on CSS selectorsconst { Documentalist } = require("documentalist");
const { writeFileSync } = require("fs");
const dm = new Documentalist();
const docs = dm.documentGlobs("src/**/*");
writeFileSync("docs.json", JSON.stringify(docs, null, 2));
This project is made available under the BSD License and includes a Patent Grant.
FAQs
A sort-of-static site generator optimized for living documentation of software projects
The npm package documentalist receives a total of 25 weekly downloads. As such, documentalist popularity was classified as not popular.
We found that documentalist 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 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.