docmark

Comment parser with support for markdown, positional info, and concrete tokens.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Extensions
  • List of extensions
  • Extension
  • Extending docdown
  • Creating a docmark extension
• Architecture
  • Overview
  • Preprocess
  • Parse
  • Postprocess
• Examples
  • Directives
  • GitHub flavored markdown (GFM)
  • Math
  • Syntax tree
• Docdown
  • CommonMark
  • Grammar
• Project
  • Version
  • Contribute
  • Sponsor
  • Origin

What is this?

TODO: what is this?

When should I use this?

TODO: when should I use this?

Install

This package is ESM only.

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

yarn add @flex-development/docmark

See Git - Protocols | Yarn for details regarding installing from Git.

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

TODO: use

API

TODO: api

Extensions

List of extensions

TODO: list of extensions

Extension

TODO: Extension

Extending docdown

TODO: extending docdown

Creating a docmark extension

TODO: creating a docmark extension

Architecture

Overview

TODO: overview

Preprocess

TODO: preprocess

Parse

TODO: parse

Postprocess

TODO: postprocess

Examples

Directives

TODO: directives

GitHub flavored markdown (GFM)

TODO: github flavored markdown (gfm)

Math

TODO: math

Syntax tree

TODO: syntax tree

Docdown

CommonMark

TODO: commonmark

Grammar

TODO: grammar

Project

Version

docmark adheres to semver.

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.

Sponsor

Consider sponsoring to support maintenance, tests, and long-term stability!

Origin

TODO: origin