Welcome to the Jackal Documentation! Here, you'll explore a secure, user-friendly, and self-custodial digital ecosystem. Whether you're looking to dive into the protocol, build innovative applications with Jackal storage, or simply satisfy your curiosity, you've come to the right place.
This documentation is built with Vocs - a modern, React-based static documentation generator powered by Vite. Vocs's documentation system is designed to be maintainable, extensible, and developer-friendly.
Clone this repository and install dependencies:
git clone https://github.com/JackalLabs/book.git
cd book
npm i vocsThen add the following scripts to your package.json:
{
"scripts": {
"docs:dev": "vocs dev",
"docs:build": "vocs build",
"docs:preview": "vocs preview"
}
}To start the development server, run:
npm run docs:devThis will launch the documentation site at http://localhost:5173.
To build the documentation for production:
npm run docs:buildTo preview the production build:
npm run docs:preview.
├── docs/
│ └── pages/
│ └── index.mdx # Main documentation page
├── package.json # Project configuration
└── README.md # This file
The following commands are available for working with the documentation:
| Command | Description |
|---|---|
npm run docs:dev |
Start the development server |
npm run docs:build |
Build the documentation site |
npm run docs:preview |
Preview the built documentation |
We welcome contributions to improve our documentation! Please see CONTRIBUTING.md for detailed guidelines on how to:
- Submit changes
- Set up your development environment
- Follow our writing style and file organization guidelines
- Troubleshoot common issues
[Add your license information here]
[Add your contact information here]
Built with Vocs 📚