Agent skill

Migrate V4 To V5

by ankitskvmdam in ankitskvmdam/clean-jsdoc-theme

Step-by-step procedure to migrate a project from clean-jsdoc-theme v4 to v5.

MITAuto-check passedDevelopment

Install Migrate V4 To V5

skills CLI
$ npx skills add ankitskvmdam/clean-jsdoc-theme --skill migrate-v4-to-v5 -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install ankitskvmdam/clean-jsdoc-theme migrate-v4-to-v5 --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/ankitskvmdam/clean-jsdoc-theme.git skills-src && mkdir -p .claude/skills && cp -r skills-src/SKILLS/migrate-v4-to-v5 .claude/skills/migrate-v4-to-v5 && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
migrate-v4-to-v5
GitHub stars
179
Token cost
~3.1k tokens
SKILL.md length
1,235 words
Files
1
Skills in repo
3
Repo updated
First seen
Licence
MIT

At a glance

Step-by-step procedure to migrate a project from clean-jsdoc-theme v4 to v5.

  • Works in 8 steps: Before you start — compatibility → Migration procedure → Option mapping → …
  • A user wants to upgrade
  • SKILL.md covers The one thing to know, 0. Before you start —…, 1. Migration procedure and 2. Option mapping, plus 5 more sections
  • Calls npm, npx and curl; reaches github.com

What it does

Migrate V4 To V5 is an agent skill from ankitskvmdam/clean-jsdoc-theme. Step-by-step procedure to migrate a project from clean-jsdoc-theme v4 to v5. Use when a user wants to upgrade, migrate, or port their JSDoc config from clean-jsdoc-theme v4 to v5 — moving options out of opts.themeopts, renaming options (baseurl→basePath, title→siteName, sections→sectionOrder, custom CSS/JS), handling removed options, reshaping the menu, and verifying the build.

Its SKILL.md is about 3.1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. It works with npm. The repository describes itself as: A clean, responsive, and customizable theme for JSDoc. https://ankdev.me/clean-jsdoc-theme/. The licence is MIT.

When your agent uses it

  • A user wants to upgrade
  • Port their JSDoc config from clean-jsdoc-theme v4 to v5 — moving options out of opts.themeopts
  • Renaming options (baseurl→basePath
  • Sections→sectionOrder

Example prompts

  • “/migrate-v4-to-v5”

Requirements

  • Node.js

Workflow steps

8 steps, taken from the step headings in SKILL.md.

  1. Before you start — compatibility
  2. Migration procedure
  3. Option mapping
  4. Removed features → replacement
  5. Before / after jsdoc.json
  6. Build & verify
  7. Common migration gotchas
  8. Staying current

What it can do on your machine

Read from SKILL.md and the folder at commit 6489b20. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • npm
    • npx
    • curl

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • github.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Migrate V4 To V5 loads about 3.1k tokens when it runs. Until then it costs about 100 tokens; SKILL.md has 1,235 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~100
When it runs · the whole SKILL.md, loaded when a task matches
~3.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from ankitskvmdam/clean-jsdoc-theme at commit 6489b20, republished under its MIT licence (© ankitskvmdam). 1,235 words, ~3,125 tokens.

Download SKILL.mdSave it as .claude/skills/migrate-v4-to-v5/SKILL.md (or your agent's skills folder).
name
migrate-v4-to-v5
description
Step-by-step procedure to migrate a project from clean-jsdoc-theme v4 to v5. Use when a user wants to upgrade, migrate, or port their JSDoc config from clean-jsdoc-theme v4 to v5 — moving options out of opts.theme_opts, renaming options (base_url→basePath, title→siteName, sections→sectionOrder, custom CSS/JS), handling removed options, reshaping the menu, and verifying the build.

Migrate clean-jsdoc-theme v4 → v5

<!-- skill-revision: 2026-06-25 -->

This skill walks a project from clean-jsdoc-theme v4 to v5. v5 is a ground-up rewrite: it server-renders every page, emits a companion .md per page, ships built-in search, a source viewer, and an opts.docs prose pipeline. The config surface changed significantly — this is the procedure to port it safely.

Skill revision: 2026-06-25. The canonical, exhaustive reference is the repo's MIGRATION.md and the machine-readable migration-map.json. If you can fetch them, prefer their current contents over anything cached here. For broader theme knowledge, pair this with the umbrella clean-jsdoc-theme skill. See §7 Staying current.

The one thing to know

v4 nested theme options under opts.theme_opts.*. v5 reads them directly from opts.* — there is no theme_opts block in v5. Most options were also renamed or removed. So migration is: lift options out of theme_opts, rename the few that carry over, drop the rest, then optionally adopt v5's new features.

0. Before you start — compatibility

  • JSDoc >=4 (v4 allowed 3.x). Node >=20.
  • The plugins/markdown plugin is no longer required by the theme (v5 renders Markdown itself) — but it's harmless to keep, and you likely want it for other reasons. (Note: the umbrella skill says JSDoc needs it; that's for fresh v5 setups where comment Markdown must be pre-rendered — verify against the user's pipeline. Keeping it is safe.)
  • Check the user really wants to move: to stay on v4, pin "clean-jsdoc-theme": "^4". v5 is now the npm latest (GA), so @latest pulls it and an unpinned range will move to v5 on the next install.

1. Migration procedure

Work through these in order. Make the edits, don't just describe them — then build and verify (§5).

<steps>
<step label="Find the current setup">

Locate the JSDoc config (usually jsdoc.json or a conf.json; sometimes inline in package.json). Confirm it's v4 by the presence of an opts.theme_opts block and/or "clean-jsdoc-theme": "^4" in package.json. Note every key under theme_opts — that's your migration work-list.

</step>
<step label="Bump the dependency">
sh
npm i -D clean-jsdoc-theme@latest   # v5 is the current `latest`

Keep template pointing at node_modules/clean-jsdoc-theme (in v5 you may point at node_modules/clean-jsdoc-theme/dist; the package main resolves either way).

</step>
<step label="Lift options out of theme_opts">

Move every opts.theme_opts.* key up to opts.*, applying the rename/removal table in §2. Then delete the now-empty theme_opts block. Renames that carry over:

  • base_url → basePath
  • title → siteName
  • sections → sectionOrder
  • create_style → customCss, include_css / add_style_path → customCssFile
  • add_scripts → customJs, include_js / add_script_path → customJsFile
</step>
<step label="Reshape the menu">

v4 entry { title, link, target, class, id } → v5 entry { id?, title?, link (or href)?, icon? }. Drop target and class; add icon (lucide:<name> or simpleicons:<name>) if you like. In v5, id also selects built-ins ({ id: "home" }, { id: "source" }), and a menu takes precedence over sectionOrder and owns the whole top region of the sidebar.

</step>
<step label="Remove what's gone">

Delete options with no v5 equivalent and tell the user what replaced them (§3): default_theme, homepageTitle, includeFilesListInHomepage, search, static_dir, exclude_inherited, displayModuleHeader, sort. (footer, meta, codepen, favicon, and shouldRemoveScrollbarStyle are not removed in v5 — map them, see §2; shouldRemoveScrollbarStyle → scrollbar: "native".) Most are now automatic (search is always on; light/dark is a runtime toggle) or moved to JSDoc's own config (static_dir).

</step>
<step label="Optionally adopt v5 features">

Migration doesn't require these, but they're the reason to be on v5 — offer them (see the umbrella skill for syntax): docs + docGroups (a prose-guides directory beside the API), fonts, siteName logo sets, copyPage / aiPrompt (LLM actions), @category / @order for sidebar structure, @iframe embeds + @playground runnable examples (CodePen/JSFiddle/CodeSandbox — the generalized successor to v4's codepen), favicon, and the source viewer (templates.default.outputSourceFiles).

</step>
</steps>

2. Option mapping

opts.theme_opts.<v4> → opts.<v5>. Status: renamed | changed | removed.

v4 (theme_opts.*)v5 (opts.*)StatusNote
default_theme—removedLight/dark token sets + runtime toggle; no picker.
base_urlbasePathrenamedSite root prefixed onto links. Default /.
faviconfaviconkeptA file path; theme copies it + emits <link rel="icon"> (needed for SVG).
homepageTitle—removedHome <title> derives from README/docs/index.md + siteName.
titlesiteNamechangedString or logo set { default, dark, light, alt }.
includeFilesListInHomepage—removedThe Source Files section lists files instead.
menumenuchangedReshaped (see step 4); target/class dropped, icon added.
sectionssectionOrderrenamedFilter + order sidebar sections.
metametachangedSupported again — array of attribute maps → <meta> tags in <head> (same shape as v4).
search—removedAlways-on fuzzy search.
codepenplaygroundchangedv4 prefilled a CodePen from @example; v5 generalizes it to opts.playground + the @playground tag (CodePen/JSFiddle/CodeSandbox). For an existing pen by URL, use @iframe.
static_dir—removedUse JSDoc's own static-file config.
create_stylecustomCssrenamedInline CSS, injected after the theme stylesheet.
include_csscustomCssFilerenamedCSS file(s); copied to a content-hashed _assets/ link.
add_style_pathcustomCssFilechangedWas an external <link>; now read + emitted as a cached asset.
add_scriptscustomJsrenamedInline JS, runs last (before </body>).
include_jscustomJsFilerenamedJS file(s); copied to a content-hashed _assets/ reference.
add_script_pathcustomJsFilechangedWas an external <script>; now read + emitted as a cached asset.
footerfooterchangedSupported again — inline HTML string or { file: "./footer.html" }; style via customCss/customCssFile.
exclude_inherited—removedNo equivalent.
displayModuleHeader—removedNo equivalent.
sort—removedNo equivalent.
shouldRemoveScrollbarStylescrollbarchangedv4 boolean only disabled scrollbar styling. v5 scrollbar is a 3-way enum: "styled" (default) | "visible" | "native". shouldRemoveScrollbarStyle: true → scrollbar: "native".

A machine-readable version of this exact map (for codemods) lives at migration-map.json in the repo root and is mirrored in MIGRATION.md §11 (v5: null means removed).

Show full SKILL.md (366 more words)Show less

3. Removed features → replacement

  • default_theme / fallback-* → built-in light/dark + runtime toggle (no opt).
  • search toggle → always on (built-in fuzzy index).
  • static_dir → JSDoc's own static-file copying. (favicon is back as an opt.)
  • homepageTitle, includeFilesListInHomepage, exclude_inherited, displayModuleHeader, sort → no replacement opt.
  • shouldRemoveScrollbarStyle → not removed; maps to scrollbar (shouldRemoveScrollbarStyle: true → scrollbar: "native").

4. Before / after jsdoc.json

v4:

json5
{
  source: { include: ["lib", "package.json", "README.md"] },
  plugins: ["plugins/markdown"],
  opts: {
    readme: "./README.md",
    destination: "docs/",
    recurse: true,
    template: "./node_modules/clean-jsdoc-theme",
    theme_opts: {
      default_theme: "dark",
      base_url: "https://example.com/docs/",
      title: "My Library",
      menu: [{ title: "GitHub", link: "https://github.com/me/lib", target: "_blank" }],
      sections: ["Classes", "Modules", "Global"],
      search: true,
      footer: "© My Library",
      include_css: ["./static/custom.css"],
    },
  },
  markdown: { idInHeadings: true },
}

v5:

json5
{
  source: { include: ["lib", "package.json", "README.md"] },
  opts: {
    readme: "./README.md",
    destination: "docs/",
    recurse: true,
    template: "./node_modules/clean-jsdoc-theme",
    // lifted out of theme_opts + renamed:
    basePath: "https://example.com/docs/",
    siteName: "My Library",
    menu: [
      { id: "home", title: "Home" },
      { title: "GitHub", link: "https://github.com/me/lib", icon: "simpleicons:github" },
    ],
    sectionOrder: ["Classes", "Modules", "Global"],
    footer: "© My Library",
    // dropped: default_theme (auto), search (always on)
    customCssFile: "./static/custom.css",
    // optional v5 upside:
    docs: "./docs",
  },
}

Diff highlights: the theme_opts block is gone; base_url→basePath, title→siteName, sections→sectionOrder; menu reshaped; search dropped; footer stays (now also accepts { file }); include_css→customCssFile.

5. Build & verify

sh
npx jsdoc -c jsdoc.json
npx serve <destination>     # islands + search index are fetched, so HTTP

Check:

  • The build completes. v5 warns on unknown/typo'd options (with a "did you mean?" hint) and continues — read the output and fix any flagged keys. Set opts.strict: true to make those warnings hard errors while migrating, then relax it.
  • A leftover theme_opts block, or any v4 option name, will show up as an unknown-key warning — that's your signal something wasn't lifted/renamed.
  • Output layout changed: pages are SSR HTML + a co-located index.md, assets live under _assets/ (e.g. _assets/styles.<buildId>.css). Any hardcoded v4 asset paths or scripts that scraped v4 output will need re-linking.
  • The site has light/dark, Ctrl K search, and (if outputSourceFiles is on) a Source Files section — all without config.

6. Common migration gotchas

  • Options silently ignored: they're still under theme_opts (v5 doesn't read it) — lift them to opts.*.
  • A renamed option "doesn't work": you kept the v4 name (title, base_url, sections, create_style, …) — apply the §2 rename. Watch the build's unknown-key warnings.
  • Custom CSS/JS vanished: the four v4 spellings were consolidated — rename to customCss / customCssFile / customJs / customJsFile. (static_dir has no equivalent — use JSDoc's static-file config.)
  • default_theme removed: there's no theme picker; customize via fonts and theme tokens (colors / darkColors), not an opt.
  • Build fails on a typo where v4 ignored it: that's strict mode — by default v5 warns and continues; only strict: true fails.

7. Staying current

Do this with restraint — at most once per session, only when relevant, and never nag. Compare the installed theme version to npm's latest and mention it if behind:

sh
npm ls clean-jsdoc-theme 2>/dev/null
npm view clean-jsdoc-theme version

For the canonical, always-up-to-date mapping, fetch MIGRATION.md / migration-map.json from the repo rather than trusting a stale cache:

sh
curl -fsSL https://raw.githubusercontent.com/ankitskvmdam/clean-jsdoc-theme/master/migration-map.json

After migrating, hand the user the umbrella clean-jsdoc-theme skill so the assistant can help them adopt the new v5 features (docs, callouts/steps/tabs, @category/@order, …) they just unlocked.

© ankitskvmdam, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in SKILLS/migrate-v4-to-v5 of ankitskvmdam/clean-jsdoc-theme.

Open the folder on GitHubat commit 6489b20

Compare with similar skills

Migrate V4 To V5 next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Migrate V4 To V5 compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Migrate V4 To V5 this skillankitskvmdam/clean-jsdoc-theme179—~3.1kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k1 repos~775Automated safety check: PassMIT
Update .NET Supported OS Matrixdotnet/core22k—~4.1kAutomated safety check: PassMIT
Ccb GitHubSeemSeam/claude_codex_bridge3.6k—~4.9kAutomated safety check: PassCustom licence
README Badges and Headersjal-co/shieldcn919—~4.3kAutomated safety check: PassMIT
Release Managerukorvl/lightweight-charts-react-components137—~1.7kAutomated safety check: PassCustom licence

Similar skills

  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 1 repo~775 tokens
    DevelopmentAuto-check passed
  • Official

    Audits and updates the supported-os.json files for .NET releases, checking them against upstream lifecycle data and regenerating the markdown with the release-notes tool.

    22k GitHub stars~4.1k tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Ccb GitHub

    SeemSeam/claude_codex_bridge

    Maintain this CCB project's GitHub-facing release and npm publication surface.

    3.6k GitHub stars~4.9k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Adds shadcn/ui-styled README badges, badge groups, download charts, header banners and sponsor or contributor grids using the shieldcn service.

    919 GitHub stars~4.3k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Release Manager

    ukorvl/lightweight-charts-react-components

    Prepare or finalize semver releases for this repository. An agent skill from ukorvl/lightweight-charts-react-components.

    137 GitHub stars~1.7k tokensUpdated 3 days ago
    DevelopmentAuto-check passed
  • Verify New Sample PR

    pnp/sp-dev-fx-aces

    Verify a "new sample" PR in pnp/sp-dev-fx-aces builds successfully, then produce a deployment + testing checklist from the sample README so it can be manually deployed and tested before merging.

    139 GitHub stars~2k tokensUpdated 13 days ago
    DevelopmentAuto-check passed

More from ankitskvmdam/clean-jsdoc-theme

  • Clean Jsdoc Theme

    ankitskvmdam/clean-jsdoc-theme

    Expert guidance for working with clean-jsdoc-theme v5 — the JSDoc/TypeDoc documentation theme.

    179 GitHub stars~3.4k tokensUpdated 1 mo ago
    Auto-check passed
  • Typedoc

    ankitskvmdam/clean-jsdoc-theme

    Expert guidance for the @clean-jsdoc-theme/typedoc plugin — using clean-jsdoc-theme v5 with TypeDoc / TypeScript.

    179 GitHub stars~3k tokensUpdated 1 mo ago
    Auto-check passed

Works with

Categories

Questions about Migrate V4 To V5

What does Migrate V4 To V5 do?

Step-by-step procedure to migrate a project from clean-jsdoc-theme v4 to v5. Migrate V4 To V5 is an agent skill from ankitskvmdam/clean-jsdoc-theme. Step-by-step procedure to migrate a project from clean-jsdoc-theme v4 to v5.

When should I use Migrate V4 To V5?

Migrate V4 To V5 fits situations like: A user wants to upgrade; port their JSDoc config from clean-jsdoc-theme v4 to v5 — moving options out of opts.themeopts; renaming options (baseurl→basePath; sections→sectionOrder.

How do I install Migrate V4 To V5 in Claude Code?

Run `npx skills add ankitskvmdam/clean-jsdoc-theme --skill migrate-v4-to-v5 -a claude-code`. Or copy the skill folder (SKILLS/migrate-v4-to-v5 in ankitskvmdam/clean-jsdoc-theme) into .claude/skills/migrate-v4-to-v5 in your project. Claude Code loads it when a task matches its description.

How do I install Migrate V4 To V5 in Codex?

Run `npx skills add ankitskvmdam/clean-jsdoc-theme --skill migrate-v4-to-v5 -a codex`. Or copy the skill folder (SKILLS/migrate-v4-to-v5 in ankitskvmdam/clean-jsdoc-theme) into .agents/skills/migrate-v4-to-v5 in your project. Codex loads it when a task matches its description.

Can I use Migrate V4 To V5 in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ankitskvmdam/clean-jsdoc-theme --skill migrate-v4-to-v5 -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/migrate-v4-to-v5, .gemini/skills/migrate-v4-to-v5, .github/skills/migrate-v4-to-v5 and .opencode/skills/migrate-v4-to-v5 in your project.

What does Migrate V4 To V5 need to run?

Going by SKILL.md and its folder, Migrate V4 To V5 needs the command-line tools its instructions call (npm, npx and curl). Our summary lists: Node.js.

Does Migrate V4 To V5 access the network?

SKILL.md names 1 domain. In commands or code: github.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Migrate V4 To V5 safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Migrate V4 To V5 use?

Migrate V4 To V5 is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Migrate V4 To V5 use?

About 3.1k tokens (SKILL.md is roughly 13k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Migrate V4 To V5?

Skills that share tags, products or a category with Migrate V4 To V5: Get API Docs with chub (andrewyng/context-hub, 14k stars), Update .NET Supported OS Matrix (dotnet/core, 22k stars), Ccb GitHub (SeemSeam/claude_codex_bridge, 3.6k stars) and README Badges and Headers (jal-co/shieldcn, 919 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Migrate V4 To V5?

ankitskvmdam (a GitHub user) maintains it in ankitskvmdam/clean-jsdoc-theme, which has 179 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on September 7, 2026.

Source: ankitskvmdam/clean-jsdoc-theme on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.