wilster-doc 是一款先进的 npm 包,它可以帮助前端开发者记录和管理自己的技术笔记,并且支持多种文件格式,例如 Markdown 和 HTML。下面我们就来看一看怎样使用 wilster-doc 来记录自己的前端笔记。
安装和基本使用
使用 npm 安装 wilster-doc 很简单:
npm install -g wilster-doc
安装完成后,我们需要使用以下指令来创建一个全新的文档:
wilster-doc create my-doc
上述指令将在当前目录下创建名为 my-doc
的文件夹,用于存放你所写的文档。在使用 wilster-doc 去写文档之前,我们需要使用以下指令进入到所创建的文件夹中:
cd my-doc
此时,在当前目录下使用以下指令便能够看到创建的模板文档结构:
wilster-doc format
添加页面
进入到文档文件夹下之后,我们就可以在其内部添加我们所需要的文档页面。使用以下指令就可以添加一个新页面:
wilster-doc add my-new-page.md
上述指令就能够在当前目录下创建一个名为 my-new-page.md
的文档页面。我们可以在这个页面上进行一些文本和图片等的编辑工作。
添加章节和目录
无论我们采用什么工具来写文档,一定离不开文章的组织和编排。使用 wilster-doc 创建文章章节和目录也是十分简单的。我们可以使用以下指令添加章节:
wilster-doc add my-new-chapter --chapter
这样,我们便创建了一个名为 my-new-chapter
的章节。如果你希望这个章节在目录中显示,可以使用 --menu
指令选项来显示。
wilster-doc add my-new-chapter --chapter --menu
通过上述指令,我们便成功地将新建的章节加入到了目录中。
内容编辑和样式
在文档中加入一些样式能够让我们的文章看起来更加精美和易读。我们可以使用 wilster-doc 提供的默认样式,也可以通过添加 CSS 文件来自定义文档样式。
为文档添加样式,我们需要在 index.html
文件中引用 CSS 样式。我们可以将自定义的 CSS 文件放在 assets/css
文件夹下,并将文件名在 index.html
中通过 link
标签引用进来。
<head> <link rel="stylesheet" href="./assets/css/my-style.css"> </head>
这样就完成了样式表的引用,我们就可以在 my-doc
文件夹下创建 my-style.css
来自定义文档样式。
在 CSS 文件中,我们可以自定义各种样式来美化文档,如:
-- -------------------- ---- ------- -- - ------ -------- ---------- ----- - - - ---------- ----- ------------ ---- ------- ---- -- -
在 CSS 文件中定义好样式后,将其引入到 index.html
文件中即可完成文档样式的设置。
导出文档
在我们完成了文档的编写之后,我们可以使用以下命令导出我们的文档。
wilster-doc export
这样我们就成功的将文档导出到了指定的位置。
总结
通过以上步骤,我们一步步了解了如何使用 wilster-doc 来创建和编辑我们自己的文档。希望这篇文章能够对你以后的学习和开发有所启发,也希望大家能够多尝试这款 npm 包,探索更多使用技巧,并将它运用到自己的前端项目中去。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005675281e8991b448e3cfc