mkdh

终端 markdown 文件转换预览器

前端八期就业班

1. 将 markdown 格式字符串转换为 html 格式字符串

使用社区提供的一个包：marked

1. 本地项目安装：npm install --save marked
2. 基本用法如下：

var marked = require('marked')
var htmlStr = marked('# hello world')
console.log(htmlStr) // => <h1>hello world</h1>

2. 实现文件变化浏览器自刷新

使用第三方包 Browsersync 可以帮助我们事先浏览器自动刷新。

• 本地项目安装（以管理员权限启动cmd）：npm install --save browser-sync

基本使用：

// 1. 加载包，直接调用 create()
var bs = require("browser-sync").create()
 
// 2. 初始化一个服务器
bs.init({
  server: './'
})
 
// 3. 刷新变化的 html 文件
bs.reload('*.html')

3. 命令行程序

需求：想要在终端中的任何目录执行自定义命令，作为一个工具来使用

3.1 手动配置

1. 找到全局包安装路径：npm root -g
2. 将项目复制到全局包安装路径下
3. 来到你的全举包安装路径的上一级路径 npm
4. 随便找到一个 .cmd 后缀的文件，复制一份
5. 将复制的 .cmd 文件，改个名字，该名字就是你想要在终端中使用的命令名称
6. 编辑 .cmd 文件，修改里面的路径，指向你刚才复制的全局包项目路径

@IF EXIST "%~dp0\node.exe" (
  "%~dp0\node.exe"  "%~dp0\node_modules\你的全局包路径下的js文件路径" %*
) ELSE (
  @SETLOCAL
  @SET PATHEXT=%PATHEXT:;.JS;=;%
  node  "%~dp0\node_modules\你的全局包路径下的js文件路径" %*
)

接下来就可以在终端中直接使用该命令了。

3.2 使用命令自动配置

• 在 package.json 文件中加入 bin 字段，如下：

"bin": {
  "itcast": "./bin/itcast.js"
}

bin 字段是一个对象，里面是键值对的形式，键表示要使用的命令名称，值表示要执行的文件路径。

注意：在所要执行的脚本代码中，第一行的位置加入如下内容（只需要入口文件有该语句即可）

#!/usr/bin/env node

• 在项目根目录下执行：npm link

执行完 npm link 之后，npm 会自动在全局报包安装路径下添加一个对你当前项目的快捷方式映射。 同时会自动在全局包安装路径的上一级目录npm下生成一个 命令名.cmd 文件。

因为 *.cmd 文件所属目录已经被配置到环境变量中了。

所以，当你在执行 itcast 的时候，实际上，根据环境变量找到了 itcast.cmd 这个可执行文件。

然后，itcast.cmd 文件中是 DOS 脚本命令（windows上专有的脚本命令）。 它内部，自动帮你去使用 node 执行 你所指定的脚本路径。

3.3 接收用户从终端中输入的参数

node 中提供了一个 process 进程对象， 可以通过该进程对象的 argv 属性获取用户从终端中传入的参数。

例如：index.js 文件代码如下：

console.log(process.argv)

然后在终端中输入：node index.js a b 回车执行，输出内容如下：

[ 'C:\\Program Files\\nodejs\\node.exe',  // 你的node可执行文件的绝对路径
  'C:\\Users\\iroc\\Desktop\\itcast-md\\lib\\index.js', // 你所执行的脚本文件的绝对路径
  'a', // 用户传入的参数
  'b' ] // 用户传入的参数

也就是说，process.argv 获取到的是一个数组， 数组中的第一个元素永远是 node 可执行文件的绝对路径， 第二个元素永远是当前执行的脚本文件的绝对路径， 从第三个参数开始，按照用户输入的内容之间的 空格 进行分隔，依次放到了该数组中。

所以，为了方便获取用户从终端中输入的参数，可以使用如下方式来获取：

// 使用数组的 slice 方法，从第二个索引下标开始截取，截取到最后
// 这样获取到的就都是用户从终端中输入的参数了
var args = process.argv.slice(2)

4. 发布到 npm

4.1 注意事项

注意1：必须将你的镜像源切换到 npm 官方镜像源

1. 改变镜像源地址方式： npm config set registry="https://registry.npm.taobao.org"
2. nrm ls 列出所有可用镜像源，星号指向的就是当前所使用的镜像源地址
3. nrm use 镜像源名称：切换到指定的镜像源

注意2：发布上去之后，npm 会将 package.json 文件中的 name 属性作为社区中的包名称 所以：发布之前先去 https://www.npmjs.com/ 网站上查询一下 package.json 文件中 name 属性指定的名称是否已存在。

4.2 发布流程

• 第一步：先在 npm 上注册一个账号 https://www.npmjs.com/signup

  • 可以在 npmjs.com 网站注册
  • 也可以在终端执行 npm adduser 命令以向导的方式进行注册

• 第二步：在终端中打开你要发布项目的根路径

  • 先执行 npm login 回车，然后以向导的方式登录 npm
  • 然后执行 npm publish

• 执行完以上操作好，去 https://www.npmjs.com/signup 网站上查询你所发布的包名

• 然后就可以让别人使用 npm install 你发布的包名 下载安装你发布的包了

• 更新发布的包：npm publish。 注意：每次更新一定要将 package.json 文件中的版本号升级一下

• 删除发布的包：npm unpublish --force 包名

• 注意事项：

  • 1、在项目根目录命令行输入 mkdh build README.md 命令，把 README.md 生成 README.html文件
  • 2、在项目根目录命令行输入 mkdh preview README.md 命令，当改动 README.md时，实时刷新 README.html
  • 3、当你的向 npm 发布报名失败时，有可能是 package.json 中的 name 属性的值已经被提交了，所以改名字即可