Security News
npm Updates Search Experience with New Objective Sorting Options
npm has a revamped search experience with new, more transparent sorting options—Relevance, Downloads, Dependents, and Publish Date.
soldoc is a solidity documentation generator. This generator was created due to a need of giving documentation to developers and clients. Thinking about it, we first created this tool to generate a standalone HTML page, but then we also decided to generate a PDF.
See demo here.
Please note that, there's also a pdf example in ./example
folder. This pdf is a first draft. We intend to have a better template and open the opportunity to get new templates.
# Go to your project folder.
cd project-folder/
# Install soldoc.
npm install --save-dev soldoc
# Install soldoc's peerDependencies (in case you don't have them yet).
npm install --save-dev directory-tree highlight.js markdown-it markdown-it-emoji meow mustache node-emoji pdf-from-html
# Run soldoc.
npx soldoc docs/ Sample.sol
# View documentation
open ./docs/Sample.html
soldoc supports many output formats, being pure HTML the default one.
Use soldoc --help
to get more information about output formats and other options.
Your can also use soldoc within your project
import { generate } from 'soldoc';
generate(outputType: string, ignoreFilesList: string[], outputFolder: string, inputPath: string)
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Credits to all external open/free material used.
Thank you all.
The sun, the A Directory Tree List Style A PEN BY Alex Raven, the Font Family. As well as Connor, who drafted the initial HTML template, and zlocate
Thank you. Danke. Merci. Grazie. Gracias. Arigato. Obrigado.
FAQs
An solidity documentation generator, based in NatSpec format.
The npm package soldoc receives a total of 5 weekly downloads. As such, soldoc popularity was classified as not popular.
We found that soldoc 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
npm has a revamped search experience with new, more transparent sorting options—Relevance, Downloads, Dependents, and Publish Date.
Security News
A supply chain attack has been detected in versions 1.95.6 and 1.95.7 of the popular @solana/web3.js library.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.