Skip to content

CookbookDev/intuition-docs

 
 

Repository files navigation

Intuition Documentation

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.

🚀 Getting Started

Prerequisites

  • Node.js >= 18.0
  • npm or yarn package manager

Installation

  1. Clone the repository:
git clone https://github.com/0xintuition/intuition-docs.git
cd intuition-docs
  1. Install dependencies:
npm install

Development

To start the development server:

npm run dev

This will start a local development server at http://localhost:3000.

Building for Production

To build the site for production:

npm run build

To preview the production build:

npm run serve

📚 Documentation Structure

  • /docs - Main documentation content
    • /guides - User guides and tutorials
  • /src - Source code for custom components and styles
  • /static - Static assets like images and files

🛠️ Available Scripts

  • npm run dev - Start development server
  • npm run build - Build the site for production
  • npm run serve - Preview production build
  • npm run lint - Run ESLint
  • npm run format - Format code with Prettier
  • npm run typecheck - Run TypeScript type checking
  • npm run spell-check - Check documentation spelling

🤝 Contributing

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.

📝 License

This project is licensed under the terms specified in the LICENSE file.

🔗 Links

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 59.3%
  • CSS 18.8%
  • TypeScript 17.7%
  • HTML 2.8%
  • Python 1.4%
  • Shell 0.0%