# md-compiler

**Repository Path**: jinko/md-compiler

## Basic Information

- **Project Name**: md-compiler
- **Description**: 将一个或者多个md文件编译成一个html文件
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-17
- **Last Updated**: 2022-10-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 使用说明

```
用法: node md-compiler {source-path} [options]

必选参数:
        source-path: 编译源文件或者目录

可选参数:

        --help
                帮助文档

        --save
                输出保存的位置

        --cssfile
                添加额外的css文件

        --jsfile
                添加额外的js文件

        --histyle
                高亮样式

        --reserve-num-prefix
                是否在目录中保留文件名的数字前缀

		--watch 
				监听目录md文件的更改并立即重新生成文档


高亮样式参数:
        a11y-dark
        a11y-light
        agate
        an-old-hope
        androidstudio
        arduino-light
        arta
        ascetic
        atelier-cave-dark
        atelier-cave-light
        atelier-dune-dark
        atelier-dune-light
        atelier-estuary-dark
        atelier-estuary-light
        atelier-forest-dark
        atelier-forest-light
        atelier-heath-dark
        atelier-heath-light
        atelier-lakeside-dark
        atelier-lakeside-light
        atelier-plateau-dark
        atelier-plateau-light
        atelier-savanna-dark
        atelier-savanna-light
        atelier-seaside-dark
        atelier-seaside-light
        atelier-sulphurpool-dark
        atelier-sulphurpool-light
        atom-one-dark
        atom-one-dark-reasonable
        atom-one-light
        brown-paper
        codepen-embed
        color-brewer
        darcula
        dark
        default
        docco
        dracula
        far
        foundation
        github
        github-gist
        gml
        googlecode
        gradient-dark
        gradient-light
        grayscale
        gruvbox-dark
        gruvbox-light
        hopscotch
        hybrid
        idea
        ir-black
        isbl-editor-dark
        isbl-editor-light
        kimbie.dark
        kimbie.light
        lightfair
        lioshi
        magula
        mono-blue
        monokai
        monokai-sublime
        night-owl
        nnfx
        nnfx-dark
        nord
        obsidian
        ocean
        paraiso-dark
        paraiso-light
        pojoaque
        purebasic
        qtcreator_dark
        qtcreator_light
        railscasts
        rainbow
        routeros
        school-book
        shades-of-purple
        solarized-dark
        solarized-light
        srcery
        stackoverflow-dark
        stackoverflow-light
        sunburst
        tomorrow
        tomorrow-night
        tomorrow-night-blue
        tomorrow-night-bright
        tomorrow-night-eighties
        vs
        vs2015
        xcode
        xt256
        zenburn
```

文件排序:  在目录中添加 `sort` 文件指定对应文件的顺序, 可以使用通配符

支持流程图:

文档 [https://mermaid-js.github.io/mermaid/#/](https://mermaid-js.github.io/mermaid/#/)

> 使用 mermaid 作为代码语法高亮


## md 功能示例模版

| key                | 说明     | 值类型 | 支持比较符          |
| ------------------ | -------- | ------ | ------------------- |
| ttype              | 桌子类型 | int    | ==, !=, in, noti    |
| tattr__tfight      | 速战房   | int    | booltrue, boolfalse |
| tattr__tding       | 定额房   | int    | booltrue, boolfalse |
| tattr__tAllprechip | 必下房   | int    | booltrue, boolfalse |
| tattr__tpro        | Pro房    | int    | booltrue, boolfalse |
| tattr__tvip        | VIP房    | int    | booltrue, boolfalse |
| tattr__tprivate    | 私人房   | int    | booltrue, boolfalse |
| tattr__tsimple     | 简易房   | int    | booltrue, boolfalse |
| tattr__tfriends    | 好友房   | int    | booltrue, boolfalse |
| tattr__tbeauty     | 美女房   | int    | booltrue, boolfalse |
| tattr__tlocal      | 区域房   | int    | booltrue, boolfalse |
| tattr__tvoice      | 语音房   | int    | booltrue, boolfalse |