什么是 selleck?
Selleck 是一个基于 Grunt 的前端文档生成器，它可以通过 Markdown 文件来构建静态页面，提供了诸如代码高亮、自动生成目录和示例代码运行等功能。
安装 selleck
首先确保您的电脑上已经安装了 Node.js 和 npm 包管理器。打开终端窗口，执行以下命令进行安装：
npm install -g selleck
创建 selleck 项目
在终端中进入您想要创建 selleck 项目的文件夹，在该文件夹下执行以下命令：
selleck init该命令会生成一个模板项目，并在其中包含一些示例文件和配置文件。其中最主要的配置文件是 Gruntfile.js，我们可以通过修改它来自定义 selleck 的构建流程。
编写 Markdown 文件
在 selleck 中，所有的文档内容都是以 Markdown 格式存储的。为了创建一个新的页面，您只需要在 src/pages 目录下创建一个新的 Markdown 文件即可。
在 Markdown 文件中，您可以使用标准的 Markdown 语法编写内容，并且可以使用 selleck 提供的一些扩展语法来实现更加灵活的效果。例如，以下是一个包含示例代码的 Markdown 文件：
# Hello, world! 这是一个示例页面。 ## 示例代码 ```javascript console.log('Hello, world!');
在上面的示例中，我们通过使用 Markdown 的代码块语法来插入 JavaScript 代码，并且这段代码会自动进行高亮显示。
构建 selleck 项目
当您完成了所有的 Markdown 文件编写之后，可以执行以下命令来构建静态页面：
selleck build该命令会执行 Gruntfile.js 中的任务，并将构建结果存储在 dist 目录下。您可以直接打开 dist/index.html 文件来查看最终生成的页面。
自定义 selleck 配置
如果您需要更加灵活地配置 selleck 的构建流程，可以修改 Gruntfile.js 文件。例如，以下是一个简单的示例，它为 selleck 添加了自动刷新功能：
-- -------------------- ---- ------- -------------- - --------------- - -- --- --------------------------- - ------- - -------- - ----- ----- ----------- ----- ----- ----- ----- ------ - - --- ----------------------------- --------- ---------- ---------- --展开代码
在上面的示例中，我们通过添加 connect 和 watch 任务来实现自动刷新功能。当您执行 grunt 命令时，selleck 将会开启一个本地服务器，并在文件变化时自动刷新页面。
总结
Selleck 是一个非常强大的前端文档生成器，它可以帮助我们快速构建静态页面，并提供了丰富的功能和扩展性。通过本文的介绍，您已经学会了如何安装 selleck、创建 selleck 项目、编写 Markdown 文件和自定义 selleck 配置。相信这些知识可以帮助您更加高效地进行前端开发工作。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/45963
