Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/guides/docusaurus-site-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,17 @@ The site deploys automatically via GitHub Actions when changes to `website/` are

**First-time setup**: Enable GitHub Pages in repo Settings → Pages → Source: GitHub Actions

## Style Guidelines

**No emoji**: Do not use emoji in the site content, components, or documentation. Use icon fonts (Lucide) for visual indicators instead.

**Icons**: The site uses [Lucide](https://lucide.dev) icon font. Use CSS classes like `icon-copy`, `icon-check`, `icon-arrow-right`. Example:
```jsx
<i className="icon-copy" />
```

**Terminal aesthetic**: Maintain the TUI/terminal visual style. Use monospace fonts, muted colors with bright accents, and clean 1px borders.

## Common Tasks

### Add a new docs section
Expand Down
37 changes: 36 additions & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ const config = {
projectName: 'sidecar',
trailingSlash: false,

customFields: {
githubUrl: 'https://github.com/marcus/sidecar',
},

onBrokenLinks: 'throw',

// Even if you don't use internationalization, you can use this field to set
Expand All @@ -40,6 +44,35 @@ const config = {
locales: ['en'],
},

headTags: [
{
tagName: 'link',
attributes: {
rel: 'preconnect',
href: 'https://fonts.googleapis.com',
},
},
{
tagName: 'link',
attributes: {
rel: 'preconnect',
href: 'https://fonts.gstatic.com',
crossorigin: 'anonymous',
},
},
],

stylesheets: [
{
href: 'https://fonts.googleapis.com/css2?family=Google+Sans+Code:ital,wght@0,300..800;1,300..800&family=JetBrains+Mono:wght@400;500;600;700&display=swap',
type: 'text/css',
},
{
href: 'https://cdn.jsdelivr.net/npm/lucide-static@latest/font/lucide.css',
type: 'text/css',
},
],

presets: [
[
'classic',
Expand Down Expand Up @@ -73,7 +106,9 @@ const config = {
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
colorMode: {
respectPrefersColorScheme: true,
defaultMode: 'dark',
disableSwitch: true,
respectPrefersColorScheme: false,
},
navbar: {
title: 'Sidecar',
Expand Down
Loading