简介
在前端开发中，文档与代码是必不可少的部分。而 literate-reader npm 包则为我们提供了一种比传统文档和代码更优雅的写作方式。其采用 markdown 格式编写，用以实现面向文档编程，也称为 Literate Programming。
安装
在命令行中输入以下命令进行安装：
npm i -g literate-reader
使用示例
在本地新建一个 my-project 目录，并在其中创建一个文件 index.md，并输入以下内容：
# Welcome to my project!
我们从简单的 Hello world 开始。
``` js
console.log('Hello world!');接下来我们来写一个加法函数。
function add(a, b) {
return a + b;
}现在我们可以来测试一下 add 函数。
console.log(add(1, 2)); // 3
这是一个非常简单的例子，但是我们可以看到使用 literate-reader，代码和文档相结合，更加直观和易于编写。
-- -------------------- ---- -------
------- ------------ -----------
-- --------
----------------- ------------ ---------------------------
----------------- -----------------------------------------
-- ----
-- ----------------- ------------------------------------------------------------------------------------ -------- --------------------------
-------------------- --------------------------------------
-- --
------- ----------------- ---------- --- --------------------------------------------------------- -----------------------------------
------------------ ---- - -------------------
- ------------------------------------------------------------------------------ --------
------------------------------------------------------------------------------------------------------------------------