d332321138
* chore: update api routes to /v2 * chore: undo erroneous uv.lock update * chore: update openapi.json |
||
|---|---|---|
| .. | ||
| _snippets | ||
| api-reference | ||
| contributing | ||
| getting-started | ||
| guides | ||
| images | ||
| logo | ||
| README.md | ||
| favicon.svg | ||
| mint.json | ||
| openapi.json | ||
| package.json | ||
| pnpm-lock.yaml | ||
README.md
Honcho Docs
These docs are built using Next.js via mintlify.
Setting Up Honcho's Docs Locally
- Clone the repository:
git clone git@github.com:plastic-labs/honcho.git
- Navigate into the
docsfolder:
cd honcho/docs/
The docs folder contains the markdown files that make up the documentation. The majority of the files are in the pages directory. Some notable files in this folder include:
- Verify that you have Node.js and npm installed in your system. You can check by running:
node --version
npm --version
-
If not installed, download Node.js and npm from the respective official websites.
-
Once you have Node.js and npm running, proceed to install
pnpm- another package manager that helps to manage project dependencies:
npm install -g pnpm
- Install the project dependencies using pnpm:
pnpm i
- After the successful installation of the project dependencies, start the local server:
pnpm dev
Now, you should be able to view the docs on your local environment by visiting http://localhost:3000. You can explore the different markdown files and make changes as you see fit.