/kliveide-docs

Documentation site for Klive IDE

Primary LanguageMDX

KliveIDE Documentation

This is the official documentation site for KliveIDE, built with Nextra.

Development

Prerequisites

  • Node.js 18+
  • npm or yarn

Getting Started

  1. Install dependencies:

    npm install

  2. Start the development server:

    npm run dev

  3. Open http://localhost:3000 in your browser.

Building for Production

npm run build

Project Structure

kliveide-docs/
├── pages/              # Documentation pages
│   ├── index.mdx       # Homepage
│   ├── getting-started.mdx
│   ├── user-guide/     # User guide section
│   ├── development/    # Development section
│   └── api-reference/  # API documentation
├── theme.config.tsx    # Nextra theme configuration
├── next.config.js      # Next.js configuration
└── package.json        # Dependencies and scripts

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test locally with npm run dev
  5. Submit a pull request

Deployment

This documentation site is automatically deployed to GitHub Pages at https://dotneteer.github.io/kliveide/ when changes are merged to the master branch.

GitHub Pages Setup

The site uses GitHub Actions for automatic deployment. The workflow:

  1. Triggers on pushes to the master branch
  2. Builds the static site using npm run export
  3. Deploys to GitHub Pages

Manual Deployment

To deploy manually:

npm run export

This creates a static build in the out/ directory that can be deployed to any static hosting service.

Other Deployment Options

This site can also be deployed to:

  • Vercel (recommended for development)
  • Netlify
  • Any static hosting service

License

MIT License - see the LICENSE file for details.