docs icon indicating copy to clipboard operation
docs copied to clipboard

feat: rewrite with Starlight

Open zlataovce opened this issue 8 months ago • 2 comments

This is a rewrite using the Starlight documentation generator instead of Docusaurus. The goal is to standardize the framework choice and look with our website (pending rewrite in Astro), improve performance, editing experience and maintainability (dropping Docusaurus hack-patches).


TODO:

  • [ ] TODOs in code
  • [ ] Components
    • [x] Javadoc - replaced with custom Markdown links (using a remark plugin)
    • [x] SoftwareVersion - replaced with MDX import+constant replacement
    • [x] Property - replaced with MDX import+constant replacement or removed altogether
    • [x] VersionFormattedCode - replaced with a remark plugin (constants defined in astro.config.ts)
    • [ ] Configuration-related components
  • [ ] Pages
    • [x] /paper/admin
      • [ ] Configuration reference
      • [x] Permissions reference
    • [x] /paper/dev
      • [ ] API pages
    • [x] /paper/contributing
    • [x] /folia/admin
    • [x] /velocity/admin
    • [x] /velocity/dev
      • [ ] Component API (passthrough to the Paper pages)
    • [x] /waterfall
      • [ ] Configuration
    • [x] /misc
      • [ ] Start script generator
      • [ ] Item command converter
    • [x] Create index.md(x) for each subdirectory - Docusaurus generates index pages, Starlight does not
  • [ ] Drop Starlight patch in favor of https://github.com/withastro/starlight/pull/3024
  • [ ] Rewrite all links to absolute ones and enable link validator
  • [x] Revise theme colors
  • [x] Add mermaid diagram support (replaced with D2)
  • [ ] Rename .mdx -> .md where no MDX features are used
    • [ ] Re-enable Prettier for .md files

Blocked on:

  • https://github.com/withastro/starlight/pull/3033
  • https://github.com/withastro/starlight/pull/3024

zlataovce avatar Apr 07 '25 18:04 zlataovce

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview 0150ae0b14a76bbfe6cadbbf8a6ddf5c3c3e4ad0

github-actions[bot] avatar Apr 07 '25 18:04 github-actions[bot]

I have no issues with us migrating to Starlight - this looks good so far.

kashike avatar Apr 08 '25 00:04 kashike

this is now mergeable (ready for review), as Starlight has merged and released the last needed feature

(project icons are currently patched in and should be replaced with https://github.com/withastro/starlight/pull/3024, but the patch can be dropped whenever, not a blocker)

zlataovce avatar Apr 16 '25 15:04 zlataovce

This is epic 🔥

EterNityCH avatar Apr 16 '25 16:04 EterNityCH