npm 包 hypermark 使用教程

什么是 hypermark

Hypermark 是一个可以将 Markdown 格式转换为 HTML 和 PDF 的命令行工具。它可以帮助前端开发人员快速生成漂亮的文档,并且支持多种主题和自定义格式。

如何安装 hypermark

在使用 hypermark 之前,需要先在本地安装 Node.js 和 npm。然后,在命令行中输入以下命令进行安装:

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

如何使用 hypermark

基本用法

在命令行中使用 hypermark 的基本语法如下:

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

其中,markdown_file 是要转换的 Markdown 文件的路径。options 可以是下列选项之一:

  • -o <output_file>:指定输出文件名,默认为输出到控制台。
  • -t <theme>:指定主题名称,默认为 default。
  • -s <stylesheet>:指定自定义样式表。
  • -r:生成 HTML 和 PDF 文件之后在浏览器中打开 HTML 文件。

例如,要将当前目录下的 test.md 文件转换为 HTML 和 PDF 文件,可以使用以下命令:

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

使用主题

Hypermark 支持多种主题,可以通过 -t 选项来指定要使用的主题名称。

目前,Hypermark 支持以下主题:

  • default
  • light
  • dark

例如,要使用 light 主题来生成 HTML 文件,可以使用以下命令:

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

自定义样式

Hypermark 支持用户定义自己的样式表,可以通过 -s 选项来指定样式表。

例如,要使用一个名为 custom.css 的样式表来生成 HTML 文件,可以使用以下命令:

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

在浏览器中打开 HTML 文件

如果需要在生成 HTML 和 PDF 文件后立即在浏览器中打开 HTML 文件,可以使用 -r 选项。例如:

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

总结

Hypermark 是一个强大且方便的命令行工具,可以帮助前端开发人员快速生成漂亮的文档。本教程介绍了 Hypermark 的基本用法、主题和自定义样式的使用方法以及如何在浏览器中打开生成的 HTML 文件。希望它可以帮助你更高效地进行前端开发工作。

示例代码

以下是一个使用 custom.css 样式表和 light 主题生成 HTML 和 PDF 文件的示例代码:

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

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60065b4ac6eb7e50355dbfd2


猜你喜欢

  • npm 包 @schwarzhirsch/sass 使用教程

    前言 随着前端技术的不断发展,CSS 预编译器已经成为一种不可或缺的前端开发工具。而 Sass 作为其中一种非常流行的 CSS 预编译器之一,不仅仅具有编写 CSS 更加快捷高效的优点,还可以提供更加...

    3 年前
  • npm 包 @uppy/server-utils 使用教程

    前言 在现代 Web 开发中,文件上传是一个很常见的需求。随着前端技术的不断发展,前端也逐渐有了越来越多的能力可以处理文件上传相关的工作。而 @uppy/server-utils 这个 npm 包,就...

    3 年前
  • npm 包 generator-epochly 使用教程

    随着前端开发的发展,越来越多的人开始接触和使用 npm 包,它们可以让我们的开发变得更为高效和便捷。其中,generator-epochly 是一款非常实用的 npm 包,它为我们提供了一个用于快速生...

    3 年前
  • npm 包 generator-standard 使用教程

    前言 在开发前端项目的过程中,我们经常需要遵守一些规范和约定,例如代码风格、命名规则、注释格式等。generator-standard 就是一款帮助开发者遵守这些规范并提高代码质量的 npm 包。

    3 年前
  • npm 包 hyper-media-control-spotify-local 使用教程

    前言 Hyper 是一个基于 Electron 技术的强大终端应用程序。它为开发者提供了一种全新的方式来使用和操作终端,而 npm 包 hyper-media-control-spotify-loca...

    3 年前
  • npm 包 jquery-time-bar 使用教程

    如果你是一个前端开发工程师,并且正在寻找一种方法来为你的用户提供很好的时间轴界面,那么 jquery-time-bar 就是一个不错的选择。该插件旨在帮助开发人员创建最佳的时间轴条,在良好的性能和访问...

    3 年前
  • npm 包 json-server-visop 使用教程

    什么是 json-server-visop? json-server-visop 是一个基于 json-server 的 npm 包,它提供了更多的功能以及可视化界面,方便开发者进行开发和调试工作。

    3 年前
  • npm 包 ng-sweetalert-2-wrapper 使用教程

    ng-sweetalert-2-wrapper 是一个基于 SweetAlert2 的 AngularJS 服务封装,它可以帮助我们更方便地在 AngularJS 程序中使用 SweetAlert2 ...

    3 年前
  • npm 包 ows-native-dns-packet 使用教程

    前言 在前端开发过程中,我们通常需要进行 DNS 解析操作。而 npm 包 ows-native-dns-packet 则提供了一种快捷的方式,方便我们在前端中进行 DNS 协议的解析和构造。

    3 年前
  • npm 包 polix-request 使用教程

    前置知识 在使用 polix-request 之前,你需要了解以下基本前端知识: Node.js 环境,以及 npm 包管理器 HTTP 协议,以及常见的请求头、响应头 Promise 模式,异步编...

    3 年前
  • npm 包 qtool 使用教程

    前言 在前端开发中,我们经常需要用到一些工具库和框架,其中一个十分常用的就是 qtool 工具库。qtool 是一款基于 jquery、underscore、backbone 等工具库开发的前端组件库...

    3 年前
  • npm 包 react-form-validizr 使用教程

    介绍 React 是一种广泛使用的前端框架,而在 React 中,表单是开发中不可避免的一个部分。而表单的验证是表单中不可或缺的一部分,而 react-form-validizr 就是一个专为 Rea...

    3 年前
  • npm 包 taskrun.io 使用教程

    在前端开发过程中,构建工具的运用非常重要,而 taskrun.io 就是一款优秀的构建工具。本文将详细介绍该工具的使用教程,包括创建新任务、运行任务,以及过滤、排序等高级用法,并提供示例代码供读者参考...

    3 年前
  • NPM包botkit-mixpanel使用教程

    在这篇文章中,我们将学习如何使用npm包 botkit-mixpanel来跟踪和分析机器人的用户交互数据。 botkit-mixpanel是一个用于创建基于机器人的分析的库。

    3 年前
  • npm 包 dom-to-image-h4 使用教程

    前言 dom-to-image-h4是一个基于js的npm包,用于将HTML DOM节点转换为图像、Canvas和SVG。HTML DOM文档是web页面在浏览器中运行时的模型。

    3 年前
  • npm 包 es6-currency-codes 使用教程

    在前端开发中,我们经常需要处理货币相关的数据,例如计算汇率、格式化货币等等。而 es6-currency-codes 是一个使用 ES6 和 TypeScript 编写的轻量级库,它提供了标准的货币码...

    3 年前
  • npm 包 hello-rl1m-npm 使用教程

    前言 在现代 web 开发中,npm 包已经成为构建前端应用的重要组成部分。很多优秀的开发者们发布了一些非常有用的 npm 包,减轻了开发者的工作负担,让开发者能够更加专注于业务逻辑的实现。

    3 年前
  • npm 包 peppa 使用教程

    Peppa 是一个便于前端开发的 npm 包,它提供了一些常用的工具函数和组件,让我们能够更加轻松地写出高质量的前端代码。 本文将从以下几个方面来介绍 Peppa 的使用: 安装 Peppa 使用 ...

    3 年前
  • npm 包 react-native-autocomplete-select 使用教程

    本文将为前端开发者介绍一款优秀的 npm 包——react-native-autocomplete-select。这个 npm 包可以帮助我们在 React Native 应用中实现自动补全下拉框,并...

    3 年前
  • npm 包 @zeix/body-scroll-lock 使用教程

    简介 随着移动互联网的发展,越来越多的网站和应用需要在移动端提供更好的用户体验。其中,滚动页面时的体验是必不可少的。但是,手机浏览器在滚动时会经常出现页面晃动、弹跳等问题,影响用户的使用感受。

    3 年前

相关推荐

    暂无文章