Quickstart

DocKit provides flexible global configuration options to customize your documentation site’s appearance, behavior, and functionality. This guide covers all the essential settings you can configure.

Configuration Files

DocKit uses several configuration files located in the src/config/ directory:

Main Configuration (config.json)

The main configuration file controls your site’s basic settings:

Configuration Options

Option

Type

Description

site.title

String

Your site’s main title

site.description

String

Brief description of your documentation

site.author

String

Default author name

site.email

String

Contact email address

site.base\_url

String

Your site’s production URL

metadata.meta\_image

String

Default Open Graph image

Theme Configuration (theme.json)

Customize your site’s visual appearance:

Theme Options

Colors

• primary\_color: Main brand color for links and buttons

• secondary\_color: Secondary elements and borders

• accent\_color: Highlights and call-to-action elements

• background\_color: Main background color

• text\_color: Default text color

Layout

• sidebar\_width: Width of the navigation sidebar

• content\_max\_width: Maximum width of content area

• enable\_breadcrumbs: Show/hide breadcrumb navigation

• enable\_toc: Show/hide table of contents

Features

• dark\_mode: Enable dark mode toggle

• search: Enable site search functionality

• print\_button: Show print button on pages

• edit\_page: Show “Edit this page” links

Navigation Menu (menu.json)

Define your site’s navigation structure:

Social Links (social.json)

Configure social media and external links:

Localization (locals.json)

Set up multi-language support:

Astro Configuration

DocKit also integrates with Astro’s configuration in astro.config.mjs:

Environment Variables

Configure environment-specific settings using .env files:

Best Practices

Performance

• Keep configuration files small and focused

• Use appropriate data types (strings, booleans, numbers)

• Avoid deeply nested structures

Maintenance

• Document your custom configurations

• Use version control for configuration changes

• Test configuration changes in development first

Security

• Never commit sensitive data to configuration files

• Use environment variables for secrets

• Validate configuration inputs

Troubleshooting

Common Issues

Configuration not loading: Ensure JSON files have valid syntax and proper file extensions.

Styles not applying: Check that theme.json values use valid CSS syntax.

Menu not showing: Verify menu.json structure matches the expected format.

Build errors: Validate all configuration files against their schemas.

---

Need help with advanced configuration? Check out our customization guide or ask in our community discussions.