micromark-factory-title
micromark factory to parse markdown titles (found in resources,
definitions).
Contents
What is this?
This package exposes states to parse titles.
When should I use this?
This package is useful when you are making your own micromark extensions.
Install
This package is ESM only.
In Node.js (version 16+), install with npm:
npm install micromark-factory-title
In Deno with esm.sh
:
import {factorySpace} from 'https://esm.sh/micromark-factory-title@1'
In browsers with esm.sh
:
<script type="module">
import {factorySpace} from 'https://esm.sh/micromark-factory-title@1?bundle'
</script>
Use
import {factoryTitle} from 'micromark-factory-title'
import {codes, types} from 'micromark-util-symbol'
function tokenizeDefinition(effects, ok, nok) {
return start
function before(code) {
if (
code === codes.quotationMark ||
code === codes.apostrophe ||
code === codes.leftParenthesis
) {
return factoryTitle(
effects,
factorySpace(effects, after, types.whitespace),
nok,
types.definitionTitle,
types.definitionTitleMarker,
types.definitionTitleString
)(code)
}
return nok(code)
}
}
API
This module exports the identifier factoryTitle
.
There is no default export.
factoryTitle(…)
Parse titles.
Examples
"a"
'b'
(c)
"a
b"
'a
b'
(a\)b)
Parameters
effects
(Effects
)
— contextok
(State
)
— state switched to when successfulnok
(State
)
— state switched to when unsuccessfultype
(string
)
— type of the whole title ("a"
, 'b'
, (c)
)markerType
(string
)
— type for the markers ("
, '
, (
, and )
)stringType
(string
)
— type for the value (a
)
Returns
Start state (State
).
Types
This package is fully typed with TypeScript.
It exports no additional types.
Compatibility
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
micromark-factory-title@2
, compatible with Node.js 16.
This package works with micromark@3
.
Security
This package is safe.
See security.md
in micromark/.github
for how to
submit a security report.
Contribute
See contributing.md
in micromark/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct.
By interacting with this repository, organisation, or community you agree to
abide by its terms.
License
MIT © Titus Wormer