Scalar Docs Starter Kit

Welcome to the Scalar Docs Starter Kit! Deploy Markdown and OpenAPI documents from GitHub.

Preview

Use the Scalar CLI to render a live preview of your project locally:

npx @scalar/cli project preview

This will start a local development server where you can view and interact with your documentation in real-time.

Validate Configuration

Ensure your project configuration is properly set up by running the configuration validation command:

npx @scalar/cli project check-config

This will verify that your scalar.config.json file contains valid settings and help identify any configuration issues.

GitHub Action

This repository includes a GitHub Action workflow that automatically validates the configuration on every push and pull request. See .github/workflows/validate-scalar-configuration.yml.

Project Structure

starter/
├── docs/
│   ├── api-reference/      # OpenAPI documents
│   └── guides/             # Free-form text
├── scalar.config.json      # Configuration

Configuration

All project configuration is managed through the scalar.config.json file. This file controls:

• Documentation structure and navigation
• OpenAPI document sources
• Theme and styling options
• Build and deployment settings

Documentation

For comprehensive guides on using Scalar Docs and setting up GitHub Sync, read the full documentation.