Skip to content

feat(to-markdown): export makeModuleDoc #308

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.

Sign up for GitHub

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 2 commits into
base: master
Choose a base branch
from
Open

feat(to-markdown): export makeModuleDoc #308

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acec2e7
feat(to-markdown): export makeModuleDoc
klasjersevi Sep 11, 2025
c1ad154
adjust jsdoc comment
klasjersevi Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions packages/to-markdown/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,14 @@ function filteredDeclarations(declarationsToFilter, omittedDeclarations, classNa

}

/** @type {import("./types/main").MakeModuleDocFn} */
function makeModuleDoc(mod, options) {
/**
* Renders a custom elements manifest module as Markdown AST
* @type {import("./types/main").MakeModuleDocFn}
* @param {import('custom-elements-manifest/schema').Module} mod
* @param {import('./types/main').Options} options
* @return {import('mdast-util-to-markdown/lib/types.js').Parent}
*/
export function makeModuleDoc(mod, options) {
const declarations = mod?.declarations ?? [];
const exportsDecl = mod?.exports ?? [];
if (!declarations.length && !exportsDecl.length)
Expand Down