@convolutionlabs/salt-docs
v0.1.6
Published
Knowledge Engine for your codebase
Downloads
32
Maintainers
Readme
@convolutionlabs/salt-docs
Knowledge Engine for your codebase - automatically generate comprehensive documentation from any GitHub/GitLab/Bitbucket repository totally locally from your machine
Installation
No installation required! Use npx:
npx @convolutionlabs/salt-docsOr install globally:
npm install -g @convolutionlabs/salt-docs
salt-docsRequirements
- Docker Desktop installed and running
- Internet connection for pulling Docker images
Quick Start
# First time setup
npx @convolutionlabs/salt-docs setup
# Start SALT Docs
npx @convolutionlabs/salt-docs startCommands
salt-docsorsalt-docs setup- Initial setupsalt-docs start- Start servicessalt-docs stop- Stop servicessalt-docs status- Check statussalt-docs logs- View logssalt-docs configure- Update configurationsalt-docs pull-docker- Pull latest docker imagessalt-docs reset- Reset configuration
Documentation
Full documentation: https://github.com/convolution-labs/salt-docs
License
Apache-2.0
