Skip to content

Latest commit

 

History

History

plugin-title

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

@mdit-vue/plugin-title

npm license

A markdown-it plugin to get page title.

  • Extracts title (the content of the first level-1 heading) into markdown-it env.title.

Install

npm i @mdit-vue/plugin-title

Usage

import { titlePlugin } from '@mdit-vue/plugin-title';
import type { MarkdownItEnv } from '@mdit-vue/types';
import MarkdownIt from 'markdown-it';

const md = MarkdownIt({ html: true }).use(titlePlugin);
const env: MarkdownItEnv = {};

const rendered = md.render(
  `\
# h1
## h2
### h3
`,
  env,
);

console.log(env.title);