remark-yaml-config
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.1 • Public • Published

    remark-yaml-config

    Build Coverage Downloads Size Sponsors Backers Chat

    remark plugin to configure it with YAML frontmatter.

    Contents

    What is this?

    This package is a unified (remark) plugin to configure remark (specifically, how remark-stringify formats markdown) from YAML frontmatter.

    unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. This is a remark plugin that configures how remark-stringify serializes mdast.

    When should I use this?

    This project is useful when you want to change how markdown is formatted from within a file. You can use this when you trust authors and want to give them control.

    This plugin is very similar to the alternative remark-comment-config. The difference is that that plugin uses comments, which can come anywhere in the document, whereas this plugin uses YAML frontmatter, which comes at the start of documents.

    Install

    This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

    npm install remark-yaml-config

    In Deno with Skypack:

    import remarkYamlConfig from 'https://cdn.skypack.dev/remark-yaml-config@6?dts'

    In browsers with Skypack:

    <script type="module">
      import remarkYamlConfig from 'https://cdn.skypack.dev/remark-yaml-config@6?min'
    </script>

    Use

    Say we have the following file example.md:

    ---
    remark:
      bullet: "+"
    ---
    
    -   Hello

    And our module example.js looks as follows:

    import {read} from 'to-vfile'
    import {remark} from 'remark'
    import remarkFrontmatter from 'remark-frontmatter'
    import remarkYamlConfig from 'remark-yaml-config'
    
    main()
    
    async function main() {
      const file = await remark()
        .use(remarkFrontmatter)
        .use(remarkYamlConfig)
        .process(await read('example.md'))
    
      console.log(String(file))
    }

    ⚠️ Important: remark-frontmatter is required to support YAML frontmatter in markdown.

    Now running node example.js yields:

    ---
    remark:
      bullet: "*"
    ---
    
    +   Hello

    API

    This package exports no identifiers. The default export is remarkYamlConfig.

    unified().use(remarkYamlConfig)

    Configure remark with YAML frontmatter. There are no options

    Parses YAML frontmatter and takes the value of the remark field as settings. The settings are passed to remark-stringify.

    Types

    This package is fully typed with TypeScript. There are no extra exported types.

    Compatibility

    Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    This plugin works with remark version 13+. Version 5 (and lower) worked with older versions of remark.

    Security

    Use of remark-yaml-config can change how markdown is parsed or compiled. If the markdown is user provided, this may open you up to a cross-site scripting (XSS) attack.

    Related

    Contribute

    See contributing.md in remarkjs/.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, organization, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i remark-yaml-config

    DownloadsWeekly Downloads

    4,638

    Version

    6.0.1

    License

    MIT

    Unpacked Size

    11.1 kB

    Total Files

    5

    Last publish

    Collaborators

    • johno
    • wooorm