@@ -26,12 +26,12 @@ Generate a complete, production-ready documentation site for any project.
2626
2727Detect from lock files, default to npm if none found:
2828
29- | Lock File | PM | Install | Run | Add |
30- | -----------| ------| ---------| -----| -----|
31- | ` pnpm-lock.yaml ` | pnpm | ` pnpm install ` | ` pnpm run ` | ` pnpm add ` |
32- | ` package-lock.json ` | npm | ` npm install ` | ` npm run ` | ` npm install ` |
33- | ` yarn.lock ` | yarn | ` yarn install ` | ` yarn ` | ` yarn add ` |
34- | ` bun.lockb ` | bun | ` bun install ` | ` bun run ` | ` bun add ` |
29+ | Lock File | PM | Install | Run | Add |
30+ | ------------------- | ---- | -------------- | ---------- | ------------- |
31+ | ` pnpm-lock.yaml ` | pnpm | ` pnpm install ` | ` pnpm run ` | ` pnpm add ` |
32+ | ` package-lock.json ` | npm | ` npm install ` | ` npm run ` | ` npm install ` |
33+ | ` yarn.lock ` | yarn | ` yarn install ` | ` yarn ` | ` yarn add ` |
34+ | ` bun.lockb ` | bun | ` bun install ` | ` bun run ` | ` bun add ` |
3535
3636Use ` [pm] ` as placeholder in commands below.
3737
@@ -56,32 +56,32 @@ Check for:
5656
5757### Determine Docs Location
5858
59- | Project Type | Target Directory | Workspace Entry |
60- | --------------| ------------------| -----------------|
61- | Standard project | ` ./docs ` | N/A |
62- | Monorepo with ` apps/ ` | ` ./apps/docs ` | ` apps/docs ` |
63- | Monorepo with ` packages/ ` | ` ./docs ` | ` docs ` |
64- | Existing ` docs/ ` folder | Ask user or ` ./documentation ` | — |
59+ | Project Type | Target Directory | Workspace Entry |
60+ | ------------------------- | ----------------------------- | --------------- |
61+ | Standard project | ` ./docs ` | N/A |
62+ | Monorepo with ` apps/ ` | ` ./apps/docs ` | ` apps/docs ` |
63+ | Monorepo with ` packages/ ` | ` ./docs ` | ` docs ` |
64+ | Existing ` docs/ ` folder | Ask user or ` ./documentation ` | — |
6565
6666### Read Context Files
6767
68- | File | Extract |
69- | ------| ---------|
70- | ` README.md ` | Project name, description, features, usage examples |
71- | ` package.json ` | Name, description, dependencies, repository URL |
72- | ` src/ ` or ` lib/ ` | Exported functions, composables for API docs |
68+ | File | Extract |
69+ | ---------------- | --------------------------------------------------- |
70+ | ` README.md ` | Project name, description, features, usage examples |
71+ | ` package.json ` | Name, description, dependencies, repository URL |
72+ | ` src/ ` or ` lib/ ` | Exported functions, composables for API docs |
7373
7474### Detect i18n Requirement
7575
7676Check if project needs multi-language docs:
7777
78- | Indicator | Action |
79- | -----------| --------|
80- | ` @nuxtjs/i18n ` in dependencies | Use i18n template |
81- | ` locales/ ` or ` i18n/ ` folder exists | Use i18n template |
82- | Multiple language README files | Use i18n template |
83- | User explicitly mentions multiple languages | Use i18n template |
84- | None of the above | Use default template |
78+ | Indicator | Action |
79+ | ------------------------------------------- | -------------------- |
80+ | ` @nuxtjs/i18n ` in dependencies | Use i18n template |
81+ | ` locales/ ` or ` i18n/ ` folder exists | Use i18n template |
82+ | Multiple language README files | Use i18n template |
83+ | User explicitly mentions multiple languages | Use i18n template |
84+ | None of the above | Use default template |
8585
8686---
8787
@@ -184,10 +184,10 @@ export default defineNuxtConfig({
184184 i18n: {
185185 locales: [
186186 { code: ' en' , language: ' en-US' , name: ' English' },
187- { code: ' fr' , language: ' fr-FR' , name: ' Français' }
187+ { code: ' fr' , language: ' fr-FR' , name: ' Français' },
188188 ],
189- defaultLocale: ' en'
190- }
189+ defaultLocale: ' en' ,
190+ },
191191})
192192```
193193
@@ -257,13 +257,13 @@ Use templates from [references/templates.md](references/templates.md).
257257
258258All Nuxt UI components in MDC must use the ` u- ` prefix:
259259
260- | Correct | Wrong |
261- | ---------| -------|
262- | ` ::u-page-hero ` | ` ::page-hero ` |
263- | ` ::u-page-section ` | ` ::page-section ` |
260+ | Correct | Wrong |
261+ | ------------------- | ----------------- |
262+ | ` ::u-page-hero ` | ` ::page-hero ` |
263+ | ` ::u-page-section ` | ` ::page-section ` |
264264| ` :::u-page-feature ` | ` :::page-feature ` |
265- | ` :::u-button ` | ` :::button ` |
266- | ` ::::u-page-card ` | ` ::::page-card ` |
265+ | ` :::u-button ` | ` :::button ` |
266+ | ` ::::u-page-card ` | ` ::::page-card ` |
267267
268268Without the ` u- ` prefix, Vue will fail to resolve the components.
269269
@@ -321,9 +321,9 @@ export default defineAppConfig({
321321 description: ' [Project description]' ,
322322 url: ' https://[docs-url]' ,
323323 socials: {
324- github: ' [org]/[repo]'
325- }
326- }
324+ github: ' [org]/[repo]' ,
325+ },
326+ },
327327})
328328```
329329
@@ -336,8 +336,8 @@ If the project has a design system or brand colors, customize the docs theme.
336336Create ` app/assets/css/main.css ` :
337337
338338``` css [app/assets/css/main.css]
339- @import " tailwindcss" ;
340- @import " @nuxt/ui" ;
339+ @import ' tailwindcss' ;
340+ @import ' @nuxt/ui' ;
341341
342342@theme static {
343343 /* Custom font */
@@ -363,8 +363,8 @@ export default defineAppConfig({
363363 url: ' https://[docs-url]' ,
364364 socials: {
365365 github: ' [org]/[repo]' ,
366- x: ' @[handle]'
367- }
366+ x: ' @[handle]' ,
367+ },
368368 },
369369 // Customize UI components
370370 ui: {
@@ -374,10 +374,10 @@ export default defineAppConfig({
374374 },
375375 pageHero: {
376376 slots: {
377- title: ' font-semibold sm:text-6xl'
378- }
379- }
380- }
377+ title: ' font-semibold sm:text-6xl' ,
378+ },
379+ },
380+ },
381381})
382382```
383383
@@ -454,12 +454,12 @@ Let me know what you'd like to improve!
454454
455455## Deployment
456456
457- | Platform | Command | Output |
458- | ----------| ---------| --------|
459- | Vercel | ` npx vercel --prod ` | Auto-detected |
460- | Netlify | ` [pm] run generate ` | ` .output/public ` |
457+ | Platform | Command | Output |
458+ | ---------------- | ------------------- | ---------------- |
459+ | Vercel | ` npx vercel --prod ` | Auto-detected |
460+ | Netlify | ` [pm] run generate ` | ` .output/public ` |
461461| Cloudflare Pages | ` [pm] run generate ` | ` .output/public ` |
462- | GitHub Pages | ` [pm] run generate ` | ` .output/public ` |
462+ | GitHub Pages | ` [pm] run generate ` | ` .output/public ` |
463463
464464---
465465
@@ -468,6 +468,7 @@ Let me know what you'd like to improve!
468468** Detected:** pnpm monorepo, package in packages/
469469
470470** Generated structure:**
471+
471472```
472473docs/
473474├── content/
@@ -491,9 +492,13 @@ docs/
491492```
492493
493494** Inside ` authentication.md ` ** (action-based H2 headings):
495+
494496``` markdown
495497## Add basic authentication
498+
496499## Protect your routes
500+
497501## Handle login redirects
502+
498503## Customize the session
499504```
0 commit comments