Skip to content

feat: rewrite with Starlight #560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 44 commits into
base: main
Choose a base branch
from
Open

feat: rewrite with Starlight #560

wants to merge 44 commits into from

Conversation

zlataovce
Copy link
Member

@zlataovce zlataovce commented Apr 7, 2025

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
    • Javadoc - replaced with custom Markdown links (using a remark plugin)
    • SoftwareVersion - replaced with MDX import+constant replacement
    • Property - replaced with MDX import+constant replacement or removed altogether
    • VersionFormattedCode - replaced with a remark plugin (constants defined in astro.config.ts)
    • Configuration-related components
  • Pages
    • /paper/admin
      • Configuration reference
      • Vanilla-like experience
      • Permissions reference
    • /paper/dev
      • API pages
    • /paper/contributing
    • /folia/admin
    • /velocity/admin
    • /velocity/dev
      • Component API (passthrough to the Paper pages)
    • /waterfall
      • Configuration
    • /misc
      • Start script generator
      • Item command converter
    • Create index.md(x) for each subdirectory - Docusaurus generates index pages, Starlight does not
  • Drop Starlight patch in favor of Add support for custom icons withastro/starlight#3024
  • Remove versioned pages, introduce version tag
  • Rewrite all links to absolute ones and enable link validator
  • Revise theme colors
  • Add mermaid diagram support (replaced with D2)
  • Rename .mdx -> .md where no MDX features are used (for better future portability)

Blocked on:

Copy link

github-actions bot commented Apr 7, 2025

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

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

@kashike
Copy link
Member

kashike commented Apr 8, 2025

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

@zlataovce zlataovce force-pushed the refactor/starlight branch from d904c8c to f2de9f4 Compare April 8, 2025 16:46
@zlataovce zlataovce force-pushed the refactor/starlight branch from ab3d290 to ebe6d9e Compare April 10, 2025 13:10
* Add item command converter

* Add button hovering

* Format
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.

4 participants