Skip to content

Replace TypeDoc documentation with MkDocs - #18

Merged
SirEdvin merged 1 commit into
1.20from
docs/mkdocs-peripheral-reference
Jul 16, 2026
Merged

Replace TypeDoc documentation with MkDocs#18
SirEdvin merged 1 commit into
1.20from
docs/mkdocs-peripheral-reference

Conversation

@SirEdvin

Copy link
Copy Markdown
Owner

Summary

  • replace the TypeDoc renderer and plugin with MkDocs Material
  • extract peripheral types, direct and inherited methods, overloads, parameters, returns, and errors through the TypeScript compiler API
  • preserve versioned Pages deployment across mixed MkDocs and legacy TypeDoc refs
  • stage Minecraft peripheral textures into generated documentation and add responsive Material styling

Verification

  • ./gradlew :typed-peripheral-digitalitems:compileTypeScript :typed-peripheral-digitalitems:generateDocs --no-daemon
  • ./gradlew :typescript-tests:compileTestLua --no-daemon
  • node --test .github/scripts/docs-site.test.mjs projects/typed-peripheral-digitalitems/documentation/generate-docs.test.mjs
  • assembled and validated a versioned preview with .github/scripts/docs-site.mjs

@SirEdvin
SirEdvin merged commit 5c91e8d into 1.20 Jul 16, 2026
2 checks passed
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