View @vivliostyle/vfm on Snyk Open Source Advisor

Package Health Score

49 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.2.1	\|	11/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.0	\|	03/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.0	\|	03/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.2	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	12/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (304)

GitHub Stars: 72
Forks: 12
Contributors: 9

Direct Usage Popularity

The npm package @vivliostyle/vfm receives a total of 304 downloads a week. As such, we scored @vivliostyle/vfm popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @vivliostyle/vfm, we found that it has been starred 72 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 9
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @vivliostyle/vfm is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 33
Open PR: 4
Last Release: 1 year ago
Last Commit: 10 months ago

Further analysis of the maintenance status of @vivliostyle/vfm based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @vivliostyle/vfm is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 12

Age: 5 years
Dependencies: 33 Direct
Versions: 38
Install Size: 78.3 kB
Dist-tags: 3
# of Files: 37
Maintainers: 7
TS Typings: No

@vivliostyle/vfm has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Vivliostyle Flavored Markdown

npm: license

Vivliostyle Flavored Markdown (VFM), a Markdown syntax optimized for book authoring. It is standardized and published for Vivliostyle and its sibling projects.

Install

npm install -g @vivliostyle/vfm

Use

vfm --help
vfm README.md
echo "# Hello" | vfm

Usage with `vivliostyle` command

npm i -g @vivliostyle/cli
vfm README.md --style https://raw.githubusercontent.com/jagat-xpub/cosmology/gh-pages/css/scholarly.css &gt; book.html
vivliostyle build book.html -s A4

API

npm install --save @vivliostyle/vfm
# or
yarn add @vivliostyle/vfm

import { stringify } from '@vivliostyle/vfm';

console.log(
  stringify(`
# はじめに

{Vivliostyle|ビブリオスタイル}の世界へようこそ。
`),
);

This snippet will generates:



  
    
    
    <title>はじめに</title>
  
  
    <h1>はじめに</h1>
    <p>
      <ruby>Vivliostyle<rt>ビブリオスタイル</rt></ruby>の世界へようこそ。
    </p>

Options

`style` (default: `undefined`)

Set the specified value as the href attribute of ``.

stringify('# Hello', { style: 'https://example.com/book.css' });

will generates:



  
    
    
    
  
  
    <p></p><h1>Hello</h1><p></p>

style can be an array of styles.

stringify('# Hello', {
  style: ['https://example.com/book.css', 'https://example.com/extra.css'],
});

will generates:



  
    
    
    
    
  
  
    <p></p><h1>Hello</h1><p></p>

`partial` (default: `false`)

If true is specified, only the HTML defined in `` is output.

stringify('# Hello', { partial: true });

will generates:

<p></p><h1>Hello</h1><p></p>

`title` (default: `undefined`)

Set the specified value as the text of <title>.

stringify('# Hello', { title: 'Hello' });

will generates:

&lt;!doctype html&gt;
&lt;html&gt;
  &lt;head&gt;
    &lt;meta charset="utf-8" /&gt;
    &lt;title&gt;Hello</title>
    
  
  
    <p></p><h1>Hello</h1><p></p>

`language` (default: `undefined`)

Set the specified value as the lang attribute of ``.

stringify('# Hello', { language: 'ja' });

will generates:



  
    
    
  
  
    <p></p><h1>Hello</h1><p></p>

`hardLineBreaks` (default: `false`)

Converts line breaks to <br>.

stringify(
  `
new
line
`,
  { hardLineBreaks: true },
);

will generates:



  
    
    
  
  
    <p>
      new<br>
      line
    </p>

`disableFormatHtml` (default: `false`)

Disable automatic HTML format. Explicitly specify true if want unformatted HTML during development or debug.

stringify(
  `text`,
  { disableFormatHtml: true },
);

will generates:








<p>text</p>

`math` (default: `true`)

Handles math syntax. The default value is true, which is valid.

stringify(
  `$x = y$`
);

will generates:



  
    
    
    
  
  
    <p><span class="math inline">\(x = y\)</span></p>

To explicitly disable it, specify false for this option or math: false for Markdown's Frontmatter.

stringify(
  `$x = y$`,
  { math: false }
);

will generates:



  
    
    
  
  
    <p>$x = y$</p>

Advanced usage

Unified processor

import { VFM } from '@vivliostyle/vfm';

const processor = VFM({ partial: true });
const html = processor.processSync('# Hello').toString();

Unified plugin

import unified from 'unified';
import vfm from '@vivliostyle/vfm/lib/revive-parse';
import html from '@vivliostyle/vfm/lib/revive-rehype';

function main() {
  unified()
    .use(vfm)
    .use(customRemarkPlugin)
    .use(html)
    .use(customRehypePlugin)
    .processSync('# Hello');
}

readMetadata

Read metadata from Markdown frontmatter.

Useful if just want to get the metadata, Markdown parse and metadata typing (for TypeScript) are handled by the VFM side.

readMetadata(md: string, customKeys: string[]): Metadata

params:
- md: String Markdown text.
- customKeys: String[] A collection of key names to be ignored by meta processing.
returns:
- metadata: Metadata Metadata.

import { readMetadata } from '@vivliostyle/vfm'

const md = `---
id: 'my-page'
lang: 'en'
dir: 'ltr'
class: 'my-class'
title: 'Title'
vfm:
  math: false
  theme: 'sample.css'
---
`;

const metadata = readMetadata(md);
console.log(metadata);

About Metadata details, refer to VFM's "Frontmatter" or type information of TypeScript.

About customKeys

Use this if want to add custom metadata with a third party tool.

Keys that are not defined as VFM are treated as meta. If you specify a key name in customKeys, the key and its data type will be preserved and stored in custom instead of meta.

import { readMetadata } from '@vivliostyle/vfm'

const md = `---
title: 'Title'
tags: ['foo', 'bar']
---
`;

const metadata = readMetadata(md, ['tags']);
console.log(metadata);

Results:

{
  title: 'title',
  custom: {
    tags: ['foo', 'bar']
  }
}

tags is stored and retained structure in custom instead of meta.

If specify a default key such as title, it will be processed as custom.

User-specified metadata

Metadata can be specified for stringify, this specification takes precedence over Frontmatter.

The following usage is assumed.

Use metadata other than Frontmatter
Process Frontmatter metadata obtained by readMetadata

stringify(
  '# Title',
  {},
  { title: 'My Page', body: [{ name: 'id', value: 'page' }] },
);

HTML:



  
    
    <title>My Page</title>
    
  
  
    <section class="level1">
      <h1>Title</h1>
    </section>

Spec

Current Status

Principles

Open: steadily improving through open discussion and feedback from the vast community.
Consistent: Provides reference implementation for parsing and converting VFM to HTML, allowing other non Vivliostyle projects to use this syntax for their purposes.

Contribution

We want you to:

Join Discussion to improve spec
Implement alpha-stage specs and send a PR
Test beta-stage features and report a bug

Maintainers

FAQs

What is @vivliostyle/vfm?

Custom Markdown syntax specialized in book authoring. Visit Snyk Advisor to see a full health score report for @vivliostyle/vfm, including popularity, security, maintenance & community analysis.

Is @vivliostyle/vfm popular?

The npm package @vivliostyle/vfm receives a total of 304 weekly downloads. As such, @vivliostyle/vfm popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @vivliostyle/vfm well maintained?

We found indications that @vivliostyle/vfm is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @vivliostyle/vfm safe to use?

While scanning the latest version of @vivliostyle/vfm, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 27 November-2024, at 03:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (304)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Table of contents

Install

Use

Usage with vivliostyle command

API

Options

style (default: undefined)

partial (default: false)

title (default: undefined)

language (default: undefined)

hardLineBreaks (default: false)

disableFormatHtml (default: false)

math (default: true)

Advanced usage

Unified processor

Unified plugin

readMetadata

User-specified metadata

Spec

Principles

Links

Contribution

Maintainers

@vivliostyle/vfm dependencies

@vivliostyle/vfm development dependencies

FAQs

What is @vivliostyle/vfm?

Is @vivliostyle/vfm popular?

Is @vivliostyle/vfm well maintained?

Is @vivliostyle/vfm safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

Usage with `vivliostyle` command

`style` (default: `undefined`)

`partial` (default: `false`)

`title` (default: `undefined`)

`language` (default: `undefined`)

`hardLineBreaks` (default: `false`)

`disableFormatHtml` (default: `false`)

`math` (default: `true`)