The official Ionic Framework documentation site, built with Docusaurus.

Note: This repository is a fork of ionic-team/ionic-docs.

Overview

This project contains the source files and build configuration for the Ionic Framework documentation website. It leverages Docusaurus to generate a static documentation site with versioned content, internationalization support via Crowdin, and custom theming.

Features

• Versioned Documentation -- supports multiple Ionic Framework versions (v5, v6, and latest)
• Internationalization -- Crowdin integration for localized documentation
• API Reference Generation -- automated scripts to generate native plugin and CLI reference docs
• Custom Theming -- tailored Docusaurus theme for the Ionic brand
• Spell Checking -- integrated cspell for documentation quality

Prerequisites

• Node.js (LTS recommended)
• npm

Getting Started

Installation

git clone https://github.com/danielcregg/ionic-docs.git
cd ionic-docs
npm install

Usage

Start the local development server:

Build the documentation for production:

Serve the production build locally:

Tech Stack

• Static Site Generator: Docusaurus
• Languages: TypeScript, JavaScript, MDX
• Internationalization: Crowdin
• Deployment: Vercel

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.