Skip to content

jimliu7434/md-html-tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

md-html-tool

concat multiple md files together and convert it to a standalone html file

Install

using npm as a devDependency

npm install --save-dev md-html-tool

or using yarn as a devDependency

yarn add --dev md-html-tool

How to use

  • add setting to your package.json

    package-setting.png

    "md-html-tool": [
        "mdfiles": [
            // all your markdown files' paths
            // beware the orders of all md files
        ],
        "target": "" // the converted html file path
    ]
  • write code like this

      const mdhtml = require('md-html-tool');
    
      (async () => {
          await mdhtml.convert();
          console.log(`completed`);
      })();

API functions

func description
convert concat all md files and convert them to one html file
getconf get all configuration from package.json

Add TOC (Table of Content)

Converter will insert TOC (Table of Content) at the position that you put <!-- toc --> ... <!-- tocstop -->

<!-- toc -->
toc will be inserted here
<!-- tocstop -->

if there is no <!-- toc --> <!-- tocstop --> , no TOC will be inserted

About

concat multiple md files together and convert it to a standalone html file

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published