docmark

a comment parser with support for markdown.

Note: This is the docmark package from the docmark monorepo.
See the monorepo readme for more on the project.
See this readme for how to use it.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Types
• Contribute

What is this?

TODO: what is this?

When should I use this?

docmark parses documentation comments, not just docblocks. Extensions can register additional comment syntaxes — such as line comments, hash comments, or language-specific documentation comments — without changing how the comment content itself is parsed.

Install

This package is ESM only.

In Node.js (version 20+) with yarn:

yarn add @flex-development/docmark

In Deno with esm.sh:

import { docmark } from 'https://esm.sh/@flex-development/docmark'

In browsers with esm.sh:

<script type="module">
  import { docmark } from 'https://esm.sh/@flex-development/docmark'
</script>

Use

TODO: use

API

TODO: api

Types

This package is fully typed with TypeScript.

Contribute

See CONTRIBUTING.md.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.