docmark-grammar

core docmark constructs.

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?

This package is useful when extending docmark.

Install

This package is ESM only.

In Node.js with yarn:

yarn add @flex-development/docmark-grammar

In Deno with esm.sh:

import {
  blankLine,
  region,
  summary,
  trailingWhitespace,
  typeExpressionValue
} from 'https://esm.sh/@flex-development/docmark'

In browsers with esm.sh:

<script type="module">
  import {
    blankLine,
    region,
    summary,
    trailingWhitespace,
    typeExpressionValue
  } from 'https://esm.sh/@flex-development/docmark'
</script>

Use

TODO: use

API

This package exports the identifiers blankLine, region, summary, trailingWhitespace, and typeExpressionValue.
There is no default export.

Each identifier is a Construct.
See the code for more info.

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.