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,069 stars 81 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 93/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
8 months ago
Last Updated
2 days ago
Language
Go
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

docusaurus

Opinionated Docusaurus documentation skill built on Diátaxis framework. Use when creating, restructuring, or improving documentation sites. Triggers on: docs/, blog/, docusaurus.config, sidebars, or any documentation task. Will ask clarifying questions to build the right structure.

6 Updated today
rio225
Web & Frontend Solid

docs

Manage project documentation - internal ./docs (init, update, check, ADR) and, via the site subcommand, the rendered public docs website (Astro Starlight): create, modernize, validate, and ship it. Canonical internal set stays small: development guidelines, system architecture, tech stack, deployment, plus append-only ADRs. Use when the user asks to update docs, record an ADR, build a docs website, add Starlight, reproduce the shared centered docs style, fix responsive docs layout, migrate a docs site, or verify and deploy developer documentation. Scouts the codebase and delegates writing to the docs-manager subagent (or stays inline with --inline).

7 Updated today
vanducng
Data & Documents Listed

docs-from-site

Spin up a rich, conversion-grade Markdown docs site from any product website URL — even one with no existing docs. Reads the live site (rendering JS first), extracts real content, and produces a multi-section, foldered site (overview, getting-started, concepts, features, guides, use-cases, FAQ, reference) — then publishes and configures the Docsbook workspace so the first thing a new visitor sees sells the product. Use when the user provides a website URL, site URL, or pastes a link and says "from website", "import site", "from URL", "from a live site", "recreate this site's docs", "copy this link", "повтори документацию по ссылке", or "сделай доки по этому сайту".

1 Updated 1 weeks ago
Docsbook-io