Skip to content
Yajing edited this page Feb 10, 2025 · 3 revisions

Overview

This wiki serves as a guide for contributors and developers working on the Olares documentation site. It includes instructions for setting up the project locally, markdown references, and style guides to ensure consistency and quality across the documentation.

For published documentation and end-user resources, visit:

Getting started

Follow these steps to preview, develop, and build the documentation locally.

Install dependencies

Install required local dependencies:

npm install

Develop

Start the local development server with hot-reloading:

npm run docs:dev

Build

Generate a production-ready static site:

npm run docs:build
Clone this wiki locally