sidecar-website

Featured

Writing and maintaining the Sidecar Docusaurus documentation site, including page structure, doc authoring, blog posts, styling, images, and deployment workflow. Use when writing documentation, updating the docs site, adding pages or blog posts, or working with Docusaurus configuration.

Web & Frontend 1,041 stars 80 forks Updated today MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Docusaurus Documentation Site The documentation site lives in `website/`. It uses Docusaurus with Node.js >= 20. ## Quick Start ```bash cd website npm install # First time only npm start # Dev server at http://localhost:3000 ``` ## Project Structure ``` website/ ├── docs/ # Markdown documentation pages ├── blog/ # Blog posts (date-prefixed markdown) │ ├── authors.yml # Blog author definitions │ └── tags.yml # Blog tag definitions ├── src/ │ ├── pages/ # Custom React pages (non-docs) │ │ ├── index.js # Front page (/) │ │ └── index.module.css │ ├── components/ # Reusable React components │ └── css/ │ └── custom.css # Global style overrides ├── static/ # Static assets (copied as-is to build) │ └── img/ # Images ├── docusaurus.config.js # Main site configuration ├── sidebars.js # Docs sidebar structure └── package.json ``` ## Writing Documentation ### Principles - **User-first**: Answer "what can I do?" before "how does it work?" - **Scannable**: Use headers, code blocks, tables for keyboard shortcuts - **Progressive disclosure**: Quick overview -> detailed usage -> full reference - **Working examples**: Every feature needs runnable code, not `...` placeholders ### Creating a New Doc Add a Markdown file in `website/docs/` with YAML frontmatter: ```markdown --- sidebar_position: 2 title: My New Page ...

Details

Author
marcus
Repository
marcus/sidecar
Created
7 months ago
Last Updated
today
Language
Go
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category