Skip to content

intentjs/docs

Repository files navigation

IntentJS Documentation

You can find the online version of the IntentjS documentation at https://tryintent.com/docs/installation.

Contribution Guidelines

If you would like to contribute to the docs, follow the local development guidelines.

Local Development

We currently use Vitepress for our documentation and all of the docs are stored inside the docs directory and the assets are stored inside the public dir.

Pre Requisites

  • NodeJS > v20.x

Setup the project

Follow the below mentioned steps after you have cloned the project.

  1. Run npm i
  2. Run npm run docs:dev
  3. Visit http://localhost:5002/docs/installation

Make your changes and raise a PR!

Submitting PR

Once you are done with your changes, you can raise a PR here.