This repository contains the documentation for Intuition Systems, built using Docusaurus. The documentation site provides comprehensive guides, API references, and best practices for using Intuition's products and services.
- Node.js >= 18.0
- npm or yarn package manager
- Clone the repository:
git clone https://github.com/0xintuition/intuition-docs.git
cd intuition-docs
- Install dependencies:
npm install
To start the development server:
npm run dev
This will start a local development server at http://localhost:3000
.
To build the site for production:
npm run build
To preview the production build:
npm run serve
/docs
- Main documentation content/guides
- User guides and tutorials
/src
- Source code for custom components and styles/static
- Static assets like images and files
npm run dev
- Start development servernpm run build
- Build the site for productionnpm run serve
- Preview production buildnpm run lint
- Run ESLintnpm run format
- Format code with Prettiernpm run typecheck
- Run TypeScript type checkingnpm run spell-check
- Check documentation spelling
We welcome contributions to improve our documentation! Please see our Contributing Guide for details on how to submit pull requests, report issues, and contribute to the documentation.
This project is licensed under the terms specified in the LICENSE file.