Skip to content

Commit 199cb8d

Browse files
committed
Format
1 parent 70aa1ad commit 199cb8d

File tree

45 files changed

+838
-692
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+838
-692
lines changed

.claude/skills/docusaurus-config/SKILL.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ description: Use when working with docusaurus.config.js/ts files to validate or
1212
Configuration lives in `docusaurus.config.js` or `docusaurus.config.ts` at project root.
1313

1414
```typescript
15-
import { Config } from '@docusaurus/types';
15+
import { Config } from "@docusaurus/types";
1616

1717
const config: Config = {
18-
title: 'My Site', // Required
19-
url: 'https://example.com', // Required, no trailing /
20-
baseUrl: '/', // Required, must start and end with /
18+
title: "My Site", // Required
19+
url: "https://example.com", // Required, no trailing /
20+
baseUrl: "/", // Required, must start and end with /
2121

22-
favicon: 'img/favicon.ico',
23-
organizationName: 'my-org',
24-
projectName: 'my-project',
22+
favicon: "img/favicon.ico",
23+
organizationName: "my-org",
24+
projectName: "my-project",
2525

2626
presets: [
2727
[
28-
'@docusaurus/preset-classic',
28+
"@docusaurus/preset-classic",
2929
{
3030
/* options */
3131
},

.claude/skills/docusaurus-config/references/detailed-guide.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Docusaurus configuration can be in multiple formats:
77
### TypeScript (Recommended)
88

99
```typescript
10-
import { Config } from '@docusaurus/types';
11-
import { themes as prismThemes } from 'prism-react-renderer';
10+
import { Config } from "@docusaurus/types";
11+
import { themes as prismThemes } from "prism-react-renderer";
1212

1313
const config: Config = {
1414
// Configuration here
@@ -38,7 +38,7 @@ module.exports = {
3838
```typescript
3939
export default async function createConfig(): Promise<Config> {
4040
// Import ESM-only packages
41-
const mdxMermaid = await import('mdx-mermaid');
41+
const mdxMermaid = await import("mdx-mermaid");
4242

4343
return {
4444
// Configuration here
@@ -204,20 +204,24 @@ function MyComponent() {
204204
When modifying config, verify:
205205

206206
1. **Required fields present**:
207+
207208
-`title` exists
208209
-`url` exists and has no trailing slash
209210
-`baseUrl` exists and starts/ends with `/`
210211

211212
2. **Plugins and themes**:
213+
212214
- ✅ Use proper package names or shorthand
213215
- ✅ Options passed as second array element
214216
- ✅ No duplicate plugins
215217

216218
3. **Custom data**:
219+
217220
- ✅ Unknown fields in `customFields` object
218221
- ✅ No direct custom properties at root level
219222

220223
4. **File format**:
224+
221225
- ✅ Valid JS/TS syntax
222226
- ✅ Proper export (ESM or CommonJS)
223227
- ✅ TypeScript types imported if using TS
@@ -256,7 +260,7 @@ plugins: [
256260

257261
```typescript
258262
const config: Config = {
259-
url: process.env.SITE_URL || 'https://localhost:3000',
263+
url: process.env.SITE_URL || "https://localhost:3000",
260264
customFields: {
261265
apiEndpoint: process.env.API_ENDPOINT,
262266
},
@@ -269,7 +273,7 @@ Create `babel.config.js`:
269273

270274
```javascript
271275
module.exports = {
272-
presets: [require.resolve('@docusaurus/babel/preset')],
276+
presets: [require.resolve("@docusaurus/babel/preset")],
273277
plugins: [
274278
// Your custom Babel plugins
275279
],

.claude/skills/docusaurus-documentation/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ When the user asks about Docusaurus features, configuration, or best practices,
1414
```typescript
1515
// Use WebFetch to access Docusaurus documentation
1616
WebFetch({
17-
url: 'https://docusaurus.io/docs/[topic]',
18-
prompt: 'What does this page say about [specific question]?',
17+
url: "https://docusaurus.io/docs/[topic]",
18+
prompt: "What does this page say about [specific question]?",
1919
});
2020
```
2121

.claude/skills/docusaurus-migration/references/breaking-changes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -130,14 +130,14 @@ This is _really_ important
130130
**Old (v1)**:
131131

132132
```js
133-
const lightTheme = require('prism-react-renderer/themes/github');
134-
const darkTheme = require('prism-react-renderer/themes/dracula');
133+
const lightTheme = require("prism-react-renderer/themes/github");
134+
const darkTheme = require("prism-react-renderer/themes/dracula");
135135
```
136136

137137
**New (v2)**:
138138

139139
```js
140-
const { themes } = require('prism-react-renderer');
140+
const { themes } = require("prism-react-renderer");
141141
const lightTheme = themes.github;
142142
const darkTheme = themes.dracula;
143143
```
@@ -150,7 +150,7 @@ Prism React Renderer v2 includes fewer languages by default. Add required langua
150150
module.exports = {
151151
themeConfig: {
152152
prism: {
153-
additionalLanguages: ['bash', 'diff', 'json'],
153+
additionalLanguages: ["bash", "diff", "json"],
154154
},
155155
},
156156
};
@@ -165,7 +165,7 @@ React imports are no longer required in files using JSX:
165165
**Before**:
166166

167167
```jsx
168-
import React from 'react';
168+
import React from "react";
169169

170170
export default function MyComponent() {
171171
return <div>Hello</div>;
@@ -261,14 +261,14 @@ Common fixes:
261261
Update Prism configuration:
262262

263263
```js
264-
const { themes } = require('prism-react-renderer');
264+
const { themes } = require("prism-react-renderer");
265265

266266
module.exports = {
267267
themeConfig: {
268268
prism: {
269269
theme: themes.github,
270270
darkTheme: themes.dracula,
271-
additionalLanguages: ['bash', 'diff', 'json'],
271+
additionalLanguages: ["bash", "diff", "json"],
272272
},
273273
},
274274
};
@@ -302,7 +302,7 @@ Fix any build errors before deploying.
302302
Convert `docusaurus.config.js` to `docusaurus.config.mjs`:
303303

304304
```js
305-
import { themes } from 'prism-react-renderer';
305+
import { themes } from "prism-react-renderer";
306306

307307
export default {
308308
// config
@@ -314,8 +314,8 @@ export default {
314314
Rename to `docusaurus.config.ts`:
315315

316316
```typescript
317-
import type { Config } from '@docusaurus/types';
318-
import { themes } from 'prism-react-renderer';
317+
import type { Config } from "@docusaurus/types";
318+
import { themes } from "prism-react-renderer";
319319

320320
const config: Config = {
321321
// config

.claude/skills/docusaurus-plugins/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ description: Use when creating Docusaurus plugins (remark, rehype, theme, conten
1313
// Remark plugin - transforms markdown AST
1414
module.exports = function remarkPlugin(options = {}) {
1515
return async function transformer(ast, vfile) {
16-
const { visit } = require('unist-util-visit');
16+
const { visit } = require("unist-util-visit");
1717

18-
visit(ast, 'link', (node) => {
18+
visit(ast, "link", (node) => {
1919
// Transform nodes
2020
node.data = node.data || {};
21-
node.data.hProperties = { className: 'custom' };
21+
node.data.hProperties = { className: "custom" };
2222
});
2323

2424
return ast;

0 commit comments

Comments
 (0)