docmark-extension-jsonc

docmark extension to support jsonc comment syntax.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • jsonComments
  • jsonBlockComment
  • jsonLineComment
• Types
• Project
  • Version
  • Contribute
  • Sponsor

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 with yarn:

yarn add @flex-development/docmark-extension-jsonc

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

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

TODO: use

API

This package exports the identifiers jsonComments, jsonBlockComment, and jsonLineComment.

The default export is jsonComments.

jsonComments

TODO: jsonComments

jsonBlockComment

TODO: jsonBlockComment

jsonLineComment

TODO: jsonLineComment

Types

This package is fully typed with TypeScript.

Project

Version

docmark-extension-jsonc 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.