docmark-extension-shell

docmark extension to support shell comment syntax.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • shellComments
  • shellComment
• 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-shell

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

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

TODO: use

API

This package exports the identifiers shellComment and shellComments.

The default export is shellComments.

shellComments

TODO: shellComments

shellComment

TODO: shellComment

Types

This package is fully typed with TypeScript.

Project

Version

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