Skip to content

Commit 196a6ca

Browse files
committed
chore(release): v0.0.2
1 parent c96cbab commit 196a6ca

File tree

1 file changed

+45
-5
lines changed

1 file changed

+45
-5
lines changed

README.md

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,7 @@ npm run test:report
100100
├── docusaurus.config.ts # Docusaurus configuration
101101
├── playwright.config.ts # Playwright configuration
102102
├── sidebars.ts # Sidebar configuration (autogenerated)
103-
├── CONTRIBUTING.md # Contributing guide (GitHub display)
104-
├── DEPLOYMENT.md # Deployment instructions
105-
└── PROJECT_SUMMARY.md # Project overview
103+
└── DEPLOYMENT.md # Deployment instructions
106104
```
107105

108106
## Deployment
@@ -171,7 +169,49 @@ The site uses environment-based configuration for URLs:
171169
- **Local Development:** `baseURL: '/'` at `http://localhost:3000`
172170
- **GitHub Pages:** `baseURL: '/docusaurus/'` at `https://sophiahacklab.github.io/docusaurus/`
173171

174-
This is automatically detected via the `GITHUB_ACTIONS` environment variable.
172+
This is automatically detected via the `BUILD_FOR_GITHUB_PAGES` environment variable.
173+
174+
### Internationalization
175+
176+
The site is configured with French (fr) as the default locale:
177+
178+
```typescript
179+
i18n: {
180+
defaultLocale: 'fr',
181+
locales: ['fr'],
182+
}
183+
```
184+
185+
### Theme Configuration
186+
187+
**Forced Dark Mode:**
188+
The site uses a custom monochrome dark theme with color mode switching disabled:
189+
190+
```typescript
191+
colorMode: {
192+
defaultMode: 'dark',
193+
disableSwitch: true,
194+
respectPrefersColorScheme: false,
195+
}
196+
```
197+
198+
**Custom Styling:**
199+
- Ultra-minimal monochrome design with pure black (#000000) backgrounds
200+
- Maximum contrast with white/gray text
201+
- Custom CSS in `src/css/custom.css` for minimalist aesthetic
202+
203+
### Mermaid Diagram Support
204+
205+
The site includes Mermaid diagram rendering capabilities via `@docusaurus/theme-mermaid`:
206+
207+
```typescript
208+
themes: ['@docusaurus/theme-mermaid'],
209+
markdown: {
210+
mermaid: true,
211+
}
212+
```
213+
214+
You can create diagrams directly in markdown using mermaid code blocks.
175215

176216
### Sidebar
177217

@@ -206,7 +246,7 @@ All blog posts feature SHL branding and are properly tagged for easy navigation.
206246

207247
## Contributing
208248

209-
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
249+
Please read [CONTRIBUTING.md](./docs/contributing.md) for details on our code of conduct and the process for submitting pull requests.
210250

211251
## About SophiaHackLab
212252

0 commit comments

Comments
 (0)