Skip to content

raid-guild/raid-guild-nextra-template

Repository files navigation

RaidGuild Nextra Docs Template

A dead-simple template for turning a folder of markdown files into a Nextra docs site.

Quick start

  1. Install dependencies with npm install.
  2. Put your markdown files in docs-src/.
  3. Use numeric prefixes (like 01-, 02-) to control sidebar order.
  4. Run npm run sync-docs to generate the Nextra app/ routes.
  5. Run npm run dev.

Folder rules

  • Each file becomes a route.
  • index.md becomes the section landing page.
  • Folders become sidebar sections automatically.

Example:

docs-src/
  index.md
  01-getting-started.md
  02-guides/
    index.md
    01-installation.md

Commands

  • npm run sync-docs generates the app/ directory from docs-src/.
  • npm run dev syncs docs and starts the dev server.
  • npm run build syncs docs and builds the site.

Notes

  • app/ is generated from docs-src/ on each sync.
  • If you need custom pages, put them in docs-src/ or extend the sync script.
  • Search is generated on build via Pagefind (npm run build runs postbuild).

Deploy to Vercel

Set the project root to this folder and use the default Next.js settings.

About

super easy docs site with search and raidguild branding

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published