npm 包 literate-reader 使用教程

简介

在前端开发中，文档与代码是必不可少的部分。而 literate-reader npm 包则为我们提供了一种比传统文档和代码更优雅的写作方式。其采用 markdown 格式编写，用以实现面向文档编程，也称为 Literate Programming。

安装

在命令行中输入以下命令进行安装：

--- - -- ---------------

使用示例

在本地新建一个 my-project 目录，并在其中创建一个文件 index.md，并输入以下内容：

- ------- -- -- --------

------ ----- ----- ---

--- --
------------------ ---------

接下来我们来写一个加法函数。

-------- ------ -- -
    ------ - - --
-

现在我们可以来测试一下 add 函数。

------------------ ---- -- -

这是一个非常简单的例子，但是我们可以看到使用 literate-reader，代码和文档相结合，更加直观和易于编写。

------- ------------ -----------

    -- --------

----------------- ------------ ---------------------------

----------------- -----------------------------------------

-- ----
-- ----------------- ------------------------------------------------------------------------------------ -------- --------------------------

-------------------- --------------------------------------

-- --
------- ----------------- ---------- --- --------------------------------------------------------- -----------------------------------

------------------ ---- - -------------------

------------------------------------------------------------------------------ ----------
-----------------------------------------------------------------------------------------------------------------------------
阅读全文

猜你喜欢

  • npm 包 nodic 使用教程

    什么是 nodic nodic 是一个轻量级的依赖注入容器，它可以帮助前端开发者更好地组织代码和管理依赖。 安装 你可以通过 npm 来安装 nodic： --- ------- ----- ----...

    3 年前
  • npm 包 gremlin-piper 使用教程

    1. 介绍 gremlin-piper 是一个基于 Apache TinkerPop™ 的使用 Node.js 开发的 gremlin (图数据库查询语言) 连接器和流处理器。

    3 年前
  • npm 包 angular-web-store 使用教程

    在前端开发中，我们经常需要使用一些包或库来完成一些复杂的功能。在管理这些包或库时，npm 包是一个非常受欢迎的选择。如果你正在开发使用 Angular 框架的应用程序，并且需要使用一个方便管理状态的工...

    3 年前
  • npm 包 jm-passport-weapp 使用教程

    介绍 jm-passport-weapp 是一个基于 JavaScript 的 npm 包，是一款适用于微信小程序的身份验证库。它提供了丰富的身份验证功能以及安全性，可以帮助开发者简化身份验证过程，并...

    3 年前
  • npm 包 `jm-passport-wechat` 使用教程

    前言 在前端开发中，无论是网站还是 App，都会涉及到用户注册、登录等操作。随着移动互联网的发展，越来越多的用户选择使用微信账号登录，在这种情况下，我们可以使用 jm-passport-wechat ...

    3 年前
  • npm 包 jm-weapp 使用教程

    简介 jm-weapp 是一个基于微信小程序的前端开发工具库，可以帮助开发者快速构建小程序应用。jm-weapp 提供了一系列简单易用的工具函数和组件，可以有效提高开发效率，同时保证代码质量和可复用性...

    3 年前
  • npm 包 giuseppe-reqres-plugin 使用教程

    1. giuseppe-reqres-plugin 简介 giuseppe-reqres-plugin 是一个 Node.js 模块，它是 giuseppe 框架的一个中间件，用于记录 HTTP 请求...

    3 年前
  • npm 包 ts-jsonschema-gen 使用教程

    npm 包 ts-jsonschema-gen 使用教程 前言 在前端开发过程中，我们难免会遇到需要进行数据模型定义的需求，我们需要定义数据的类型、属性、枚举等等。

    3 年前
  • npm 包 bookie-d3-transition 使用教程

    概述 bookie-d3-transition 是一个基于 D3.js 的过渡库。它扩展了原生的 D3 过渡能力，提供了更加丰富的过渡效果，可帮助开发者更加便捷地实现各种复杂的过渡效果。

    3 年前
  • npm 包 svg-loading 使用教程

    前言 在前端网页的开发过程中，我们经常需要在页面中添加 loading 效果来提升用户体验。svg-loading 是一个纯代码的加载动画库，通过它我们可以轻松地在页面中添加漂亮的加载动画。

    3 年前
  • npm 包 torn-test-ui 使用教程

    前言 在前端开发中，测试是非常重要的一环。作为一个开发者，我们需要保证我们代码的可靠性和正确性。为了方便地进行前端测试，torn-test-ui 库被开发出来。它可以帮助我们轻松地进行 UI 测试、集...

    3 年前
  • npm 包 vue2-checklist 使用教程

    简介 vue2-checklist 是一款基于 Vue2 的轻量级、易用的多选框组件，可以帮助开发者快速构建多选框组件。 安装 使用 npm 安装 vue2-checklist： --- ------...

    3 年前
  • npm 包 fma 使用教程

    前言 在前端开发中，使用 fma 这个 npm 包可以让我们更加便捷地进行各种数学运算，尤其是复杂数学运算。本文将详细介绍 fma 包的使用方法，并通过示例代码来帮助读者深入理解。

    3 年前
  • npm 包 stdin-to-files-cli 使用教程

    在日常开发过程中，我们经常需要将控制台输入的信息保存到本地文件中。npm 包 stdin-to-files-cli 就是为此而生的，通过将标准输入转化为文件输出，方便我们进行文件操作。

    3 年前
  • npm包@timesinternet/times-storage使用教程

    在前端开发中，经常需要从客户端存储或从服务器获取数据。在这种情况下，使用一个合适的存储库是必要的。@timesinternet/times-storage是一个可以帮助你管理数据存储的npm包。

    3 年前
  • npm 包 fma-cli 使用教程

    前言 fma-cli 是一个基于 Node.js 的命令行工具，它可以帮助前端开发者快速地创建项目模板、添加页面、组件等功能，提高前端开发效率，同时也可以帮助开发者规范化自己的工作流程。

    3 年前
  • npm 包 lovearth-xdua-nodejs-sdk 使用教程

    npm 包 Lovearth-xdua-nodejs-sdk 使用教程 简介 Lovearth-xdua-nodejs-sdk 是一款针对 Node.js 环境下的 Lovearth 开发平台的 SD...

    3 年前
  • npm 包 ng-owl-carousel 使用教程

    npm 包 ng-owl-carousel 使用教程 前言 ng-owl-carousel 是一个非常友好的 AngularJS 轮播插件，能够帮助前端开发者快速地实现页面的轮播效果。

    3 年前
  • npm 包 wk-core 使用教程

    前言 随着前端技术的迅速发展和变化，我们需要不断学习最新的技术和工具，以保持竞争力。其中，npm 是一个非常重要的前端工具，因为它可以让我们方便地管理和分享代码包。

    3 年前
  • npm包fma-snes65816使用教程

    什么是fma-snes65816 fma-snes65816是一个npm包，用于编写SNES游戏的汇编语言代码。它基于65816指令集，提供了一些易于使用的API，可以方便地访问硬件设备和游戏资源。

    3 年前

相关推荐

    暂无文章