https://github.com/scalar/starter

Scalar Docs Starter Kit
https://github.com/scalar/starter

docs openapi scalar starter-kit swagger template

Last synced: 8 days ago
JSON representation

Scalar Docs Starter Kit

• Host: GitHub
• URL: https://github.com/scalar/starter
• Owner: scalar
• License: mit
• Created: 2025-01-18T06:52:54.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2026-01-22T15:59:29.000Z (11 days ago)
• Last Synced: 2026-01-23T08:47:01.919Z (11 days ago)
• Topics: docs, openapi, scalar, starter-kit, swagger, template
• Homepage: https://scalar.com
• Size: 53.7 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Scalar Docs Starter Kit

[![Contributors](https://img.shields.io/github/contributors/scalar/starter)](https://github.com/scalar/starter/graphs/contributors)

[![GitHub License](https://img.shields.io/github/license/scalar/starter)](https://github.com/scalar/starter/blob/main/LICENSE)

[![Twitter](https://img.shields.io/twitter/follow/scalar)](https://x.com/scalar)

[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)

Welcome to the Scalar Docs starter kit! This project provides you with a complete foundation to create beautiful, interactive API documentation using Scalar's powerful documentation platform.

## Preview

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

```bash

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:

```bash

npx @scalar/cli project check-config

```

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

## 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`](./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](https://guides.scalar.com/scalar/scalar-docs/github-sync).