honcho/docs

Honcho Docs

These docs are built using Next.js via mintlify.

Setting Up Honcho's Docs Locally

1. Clone the repository:

git clone git@github.com:plastic-labs/honcho.git

2. Navigate into the docs folder:

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:

3. Verify that you have Node.js and npm installed in your system. You can check by running:

node --version
npm --version

4. If not installed, download Node.js and npm from the respective official websites.

5. 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

6. Install the project dependencies using pnpm:

pnpm i

7. 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.