i5ting_toc Nodejs模块：把markdown编译成带有toc目录的html

i5ting_toc Nodejs模块：把markdown编译成带有toc目录的html

i5ting_toc 是把markdown编译成带有toc目录的html的node模块

i5ting_toc

i5ting_toc a node npm wrapper of i5ting_ztree_toc https://github.com/i5ting/i5ting_ztree_toc

npm version

Preview

3.png

Install

npm install -g i5ting_toc

Usage

➜  tocmd.npm git:(master) ✗ i5ting_toc -h

Usage: i5ting_toc  a node npm wrapper of i5ting_ztree_toc https://github.com/i5ting/i5ting_ztree_toc


Options:


-h, --help             output usage information
-V, --version          output the version number
-f, --file [filename]  default is README.md 
	-o, --open             open in browser
-v, --verbose          打印详细日志

这个版本的命令比较简单，只有一个-f参数，如果没有填写，默认使用README.md，常见用法

i5ting_toc -f sample.md -o

写文档很方便哦

刚发布，热乎乎的，欢迎尝试


4 回复

i5ting_toc Nodejs模块：把markdown编译成带有toc目录的html

简介

i5ting_toc 是一个用于将 Markdown 文件转换为包含目录（Table of Contents, TOC）的 HTML 的 Node.js 模块。它基于 i5ting_ztree_toc 进行封装，提供了方便的命令行工具。

安装

首先，你需要全局安装 i5ting_toc：

npm install -g i5ting_toc

使用示例

i5ting_toc 提供了简单的命令行选项来处理 Markdown 文件并生成带目录的 HTML 文件。以下是一些常用的命令示例：

# 将默认的 README.md 转换为 HTML，并在浏览器中打开
i5ting_toc -o

# 将指定的 sample.md 转换为 HTML，并在浏览器中打开
i5ting_toc -f sample.md -o

详细说明

  • -f, --file [filename]: 指定要转换的 Markdown 文件，默认为 README.md。
  • -o, --open: 在浏览器中打开生成的 HTML 文件。
  • -v, --verbose: 打印详细日志信息。
  • -h, --help: 显示帮助信息。
  • -V, --version: 显示当前模块的版本号。

示例代码

假设你有一个名为 example.md 的 Markdown 文件，内容如下：

# 标题一

这是标题一的内容。

## 标题二

这是标题二的内容。

### 标题三

这是标题三的内容。

你可以使用以下命令将其转换为包含目录的 HTML 文件并在浏览器中打开：

i5ting_toc -f example.md -o

执行上述命令后，i5ting_toc 会读取 example.md 文件，解析其中的 Markdown 文本，并生成一个包含目录的 HTML 文件。生成的 HTML 文件会在浏览器中自动打开，方便查看和导航。

总结

i5ting_toc 是一个非常实用的工具，特别适合开发者编写和维护技术文档时使用。它不仅能够快速将 Markdown 文件转换为 HTML，还能自动生成目录，极大地提升了文档的可读性和易用性。


Api Usages

示例说明

var source_file = 'sample.md';

var markd_config = {
debug: false
}


require(‘i5ting_toc’)(source_file, is_open, markd_config);

参数说明

  • source_file 要编译的mardown文件
  • is_open 是否在编译后使用浏览器中打开html
  • markd_config 编译md的选项（具体见 https://github.com/chjj/marked ）

gulp task for i5ting-toc

Usage

var gulp = require('gulp');
var i5ting_toc = require('./');

var opt = {
source_file: ‘sample.md’,
is_open: true,
markd_config: {
debug: false
}
}


gulp.task(‘default’, function() {
gulp.src(‘sample.md’)
.pipe(i5ting_toc(opt));
});

i5ting_toc 是一个用于将 Markdown 文件转换为包含目录（TOC）的 HTML 文件的 Node.js 模块。它基于另一个名为 i5ting_ztree_toc 的项目，并且提供了一个简单的命令行工具来方便地生成 HTML 文档。

安装

你可以通过以下命令安装 i5ting_toc：

npm install -g i5ting_toc

使用

安装完成后，你可以使用以下命令来生成 HTML 文件：

i5ting_toc -f sample.md -o

这条命令会读取 sample.md 文件并将其转换为包含目录的 HTML 文件，并自动在浏览器中打开。

示例代码

假设你有一个名为 example.md 的 Markdown 文件，内容如下：

# 第一章

这是第一章的内容。

## 1.1 子章节

这是子章节的内容。

# 第二章

这是第二章的内容。

运行以下命令：

i5ting_toc -f example.md -o

这将生成一个包含目录的 HTML 文件，并在浏览器中打开。

目录生成效果

生成的 HTML 文件会包含一个目录（TOC），该目录列出了所有的章节和子章节，方便用户导航。

命令选项说明

  • -h, --help：输出帮助信息。
  • -V, --version：输出版本号。
  • -f, --file [filename]：指定需要转换的 Markdown 文件，默认为 README.md。
  • -o, --open：生成的 HTML 文件会在浏览器中自动打开。
  • -v, --verbose：打印详细日志。

通过这些简单的步骤，你可以轻松地将 Markdown 文件转换为包含目录的 HTML 文件。

回到顶部