Skip to content

nuxt: migrate handbook to Nuxt with @nuxt/content#5065

Open
ZJvandeWeg wants to merge 3 commits into
mainfrom
zj-handbook-nuxt
Open

nuxt: migrate handbook to Nuxt with @nuxt/content#5065
ZJvandeWeg wants to merge 3 commits into
mainfrom
zj-handbook-nuxt

Conversation

@ZJvandeWeg
Copy link
Copy Markdown
Member

Adds a three-column handbook layout (left nav / content / TOC) served by Nuxt, replacing 11ty for /handbook/** routes. Includes multi-level nav tree, Algolia search, scroll-spy TOC, breadcrumbs, and a remark plugin to resolve relative image/link paths under the trailing-slash URL scheme Nuxt uses.

Related Issue(s)

Checklist

  • I have read the contribution guidelines
  • I have considered the performance impact of these changes
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
  • For blog PRs, an Art Request has been created (instructions)

Adds a three-column handbook layout (left nav / content / TOC) served
by Nuxt, replacing 11ty for /handbook/** routes. Includes multi-level
nav tree, Algolia search, scroll-spy TOC, breadcrumbs, and a remark
plugin to resolve relative image/link paths under the trailing-slash URL
scheme Nuxt uses.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 26, 2026

👷 Deploy Preview for flowforge-website processing.

Name Link
🔨 Latest commit 4782ca3
🔍 Latest deploy log https://app.netlify.com/projects/flowforge-website/deploys/6a1700301df1af000818e18b

ZJvandeWeg and others added 2 commits May 27, 2026 05:32
Use git mv to transfer all 167 handbook markdown pages into the Nuxt
content directory, picking up the four files that changed on main
after the initial migration commit:

- company/security/ai-development-and-customer-data.md (new AI tools section)
- marketing/blog.md (AI tag, updated content calendar link)
- marketing/messaging.md (new sales tech stack; expand Nunjucks template
  var site.messaging.shortDescription to its literal value for Nuxt)
- sales/index.md (new sales tech stack section)

Two 11ty-only .njk templates (features.njk, subscription-agreement-1.5.njk)
are moved along with their directories; they will be removed when the 11ty
handbook collection is cleaned up in the next commit.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- git mv src/handbook/images → nuxt/public/handbook/images so the 53
  handbook images are tracked in git and served statically by Nuxt
- Update nuxt/.gitignore: narrow the public/ exclusion so only
  public/handbook/images/ is tracked; all other 11ty-generated
  public/ output remains gitignored
- Update clean:nuxt script to preserve public/handbook/ during build
  cleans so committed images survive the rimraf step
- Remove handbook.json (11ty collection config) and LICENSE
- Remove two 11ty-only .njk templates that had no Nuxt equivalent
  (engineering/product/features.njk, sales/subscription-agreement-1.5.njk)
- Drop handbookBreadcrumbs and rewriteHandbookLinks filters from
  .eleventy.js (no longer needed)
- Remove createNav('handbook') call and update inline comments
- Strip /handbook/ from the docsFeatureBadges URL pattern

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant