docmark-factory-block

docmark factory to parse block comments.

Contents

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

What is this?

This package exposes a construct factory.

The returned construct parses block comments.

When should I use this?

This package may be useful when making your own docmark extensions.

Install

This package is ESM only.

In Node.js with yarn:

yarn add @flex-development/docmark-factory-block

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

TODO: use

API

TODO: api

Types

This package is fully typed with TypeScript. It exports no additional types.

Project

Version

docmark-factory-block 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

Small primitives power larger systems. Support long-term stability by sponsoring Flex Development.