Skip to content

Add clean-jsdoc-theme to Documentation - #1193

Open
ankitskvmdam wants to merge 1 commit into
sorrycc:masterfrom
ankitskvmdam:add-clean-jsdoc-theme
Open

ankitskvmdam wants to merge 1 commit into
sorrycc:masterfrom
ankitskvmdam:add-clean-jsdoc-theme

Conversation

@ankitskvmdam

Copy link
Copy Markdown

Adds clean-jsdoc-theme to the Documentation section.

What it is

A theme for JSDoc (and TypeDoc, through a companion plugin) that turns your source comments plus a folder of Markdown guides into a static documentation site:

  • Built-in search: a Ctrl K command palette across titles, descriptions, and page text, with deep links to class members
  • Light and dark themes, a table of contents, and copy buttons on code blocks
  • Hand-written guides and generated API reference in one sidebar and one search index
  • i18n: one static site per language
  • A Markdown copy of every page, so the API reference is easy for LLMs to read
  • No CSS or build config needed to get started: set "template": "./node_modules/clean-jsdoc-theme/dist" in jsdoc.json

Why it belongs here

Screenshots

Light theme:

clean-jsdoc-theme, light theme

Dark theme:

clean-jsdoc-theme, dark theme

Checklist

  • Searched previous suggestions; no duplicate
  • One suggestion in this pull request
  • Format [PACKAGE](LINK) - DESCRIPTION., ending with a period
  • Added at the end of the Documentation section

Disclosure: I'm the maintainer of clean-jsdoc-theme.

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