npm 包 fiddly 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

1. 什么是 fiddly?

fiddly 是一个基于 markdown 生成静态网站的 npm 包。它的出现极大地方便了前端工程师快速开发和部署静态网站,特别是对于个人博客、简历等小型网站,更是提供了极大的便利。

fiddly 具有以下特点:

  • 提供多种主题选择,美观可定制化程度高;
  • 支持代码高亮、导航栏、底部信息等功能;
  • 生成的静态文件部署简单,可以上传至 CDN 或者 Github Pages 等托管平台;
  • 调试方便,可以在本地预览 ;

2. fiddly 的安装和使用

安装

全局安装 fiddly:

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

初始化项目

在你的项目目录下运行以下命令:

------ ----

该命令将询问你一些问题,包括主题、网站名称、网站描述、作者、关键字等,输入完毕后将生成模板文件。

编辑模板

打开生成的目录,你会看到 fiddly 为我们提供了以下目录结构:

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

其中,index.md 是你的网站首页,你可以在这个文件中编写内容,使用 markdown 格式排版。公共资源可以放在 public 目录中,.fiddlyrc.json 是 fiddly 的配置文件,你可以根据需求修改其中的参数。

生成网站

当我们完成了编辑网站内容以及配置,就可以使用以下命令生成网站:

------ -----

生成的文件将放在 /dist 目录下,你可以直接打开 index.html 预览网站。

部署网站

将生成的 /dist 下的静态文件上传至 CDN 或者 Github Pages 等托管平台即可。

3. fiddly 的进阶使用

主题定制

fiddly 支持多种主题,你可以在 .fiddlyrc.json 文件中修改 theme 字段,切换主题。

对于想要进一步定制主题的用户,可以在项目根目录下创建 theme.ejs 文件,fiddly 会自动寻找该文件,并将其作为模板进行渲染。此时,你可以在模板中使用 EJS 语法,进一步对主题进行定制。

导航栏和底部信息

在 .fiddlyrc.json 文件中可以设置导航栏和底部信息(footer)。你可以根据需求修改其中的参数。

插件

fiddly 支持插件,可以在 .fiddlyrc.json 文件中添加 plugins 字段,引入插件。

例如,想使用 vue 组件在网站中渲染,可以引入 fiddly-plugin-vue:

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

然后,在 .fiddlyrc.json 文件中添加以下代码:

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

这样,你就可以在网站中使用 vue 组件了。

4. 示例代码

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

.fiddlyrc.json:

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

index.md:

- ----- -----

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

-- ------- -

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

-- ------- -

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

结语

fiddly 是一个十分优秀的 npm 包,不仅使得快速搭建静态网站变得轻松,同时也提供了主题定制、插件等进阶功能,方便用户进行二次开发。希望这篇文章可以帮助大家更好地使用 fiddly。

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


猜你喜欢

  • npm 包 @lklabs/riakpbc 使用教程

    使用 @lklabs/riakpbc npm 包进行Riak数据库操作 Riak是一个分布式NoSQL数据库,它的强大和灵活性使其成为许多企业和开发人员的首选。而@lklabs/riakpbc是一个n...

    4 年前
  • npm 包 mathoid-mathjax-node 使用教程

    使用 mathoid-mathjax-node 包在前端页面中渲染数学公式 在前端开发中,有时需要在网页中展示数学公式。mathoid-mathjax-node 是一个 npm 包,可以用于将 LaT...

    4 年前
  • npm 包 mock-express-request 使用教程

    Npm包: mock-express-request使用教程 当我们在前端开发中遇到后端接口不可用或者还未完成时,我们可能需要模拟一个假的请求来测试我们的前端代码。

    4 年前
  • npm 包 mock-express-response 使用教程

    在前端开发中,我们经常需要模拟后端 API 的响应数据以测试前端功能。mock-express-response 是一个 Node.js 的 npm 包,可以方便地模拟 Express 响应对象,并返...

    4 年前
  • npm 包 service-runner 使用教程

    使用 Service-Runner 运行前端服务 Service-Runner 是一个优秀的 npm 包,可以帮助开发者快速构建和管理前端应用程序。本文将详细介绍如何使用 Service-Runner...

    4 年前
  • npm 包 texvcinfo 使用教程

    NPM包texvcinfo使用教程 简介 texvcinfo是一个npm包,可用于在Node.js和浏览器应用程序中解析TeX公式并提取有关其结构的信息。它可以帮助开发者将Tex公式转换为MathML...

    4 年前
  • npm 包 reverse-test 使用教程

    在前端开发过程中,我们经常会用到各种npm包,而 reverse-test 是一个方便的工具,可以快速地将字符串反转。本文将详细介绍如何使用该npm包,以及其深度和学习意义,并包含示例代码。

    4 年前
  • npm 包 binding 使用教程

    NPM包Binding使用教程 NPM是Node.js的包管理器,可以方便地安装、更新和卸载模块。Binding是一种Node.js模块,它连接了JavaScript代码和本地C/C++代码。

    4 年前
  • npm 包 zero-builders-map 使用教程

    使用 Zero-builders-map 对前端项目进行构建 在前端项目开发过程中,使用构建工具对代码进行打包、压缩等操作已经成为了常态。而 npm 包 zero-builders-map 则是一款基...

    4 年前
  • npm 包 node-require-async 使用教程

    使用 node-require-async 实现异步加载 Node.js 模块 在 Node.js 应用开发中,我们经常需要引入其他模块进行编程。通常情况下我们使用 require 函数来引入所需的模...

    4 年前
  • npm 包 objectorarray 使用教程

    使用 npm 包 objectorarray 在前端开发中,我们常常需要处理对象或数组的数据。npm 包 objectorarray 是一个工具库,它提供了一些强大的方法来操作和转换对象或数组。

    4 年前
  • npm 包 eslint-config-pwn-es5 使用教程

    使用 eslint-config-pwn-es5 提高前端代码质量 在前端开发中,编写规范化的代码非常重要。使用 ESLint 工具可以帮助我们实现代码风格的统一以及代码质量的提升。

    4 年前
  • npm 包 index-modules 使用教程

    npm 是一个常用的 JavaScript 包管理工具,里面包含了许多有用的模块和库,可以方便地在你的项目中使用。index-modules 是一个 npm 包,它提供了一种简单的方式来列举和加载某个...

    4 年前
  • npm 包 ip-subnet-calculator 使用教程

    使用npm包ip-subnet-calculator进行子网计算 在网络管理和安全方面,了解如何计算IP地址和子网掩码是非常重要的。 ip-subnet-calculator是一个实用的npm包,它可...

    4 年前
  • npm 包 node-slack-upload 使用教程

    使用node-slack-upload npm包上传文件到Slack node-slack-upload是一个Node.js模块,它允许您轻松地将文件上传到Slack。

    4 年前
  • npm 包 inquirer-question 使用教程

    使用 inquirer-question 的 npm 包:一个完整的指南 如果您是一名前端开发者,那么您肯定会使用 Node.js 和 NPM 包管理器。在这里,我们将重点介绍一个非常有用的 NPM ...

    4 年前
  • npm 包 audio-frequency-to-index 使用教程

    在前端开发中,经常会涉及到音频处理。而在音频处理过程中,频率与索引之间的转换是一个非常重要的环节。此时引入一个实用的 npm 包:audio-frequency-to-index,可以帮助我们更方便地...

    4 年前
  • npm 包 is-emoji 使用教程

    使用 is-emoji NPM 包来检查 Emoji Emoji 已经成为我们现代通信的一部分,而在开发应用程序时,我们经常需要对用户输入的文本进行检查,以确保其中不包含表情符号。

    4 年前
  • npm 包 split-array 使用教程

    使用 npm 包 split-array 进行数组分割 在前端开发中,我们常常需要对数组进行分割操作。而 split-array 是一个方便的 npm 包,可以帮助我们快速地进行数组分割。

    4 年前
  • npm 包 conform-async 使用教程

    使用 conform-async npm 包实现异步函数验证:一个详细的教程 在前端开发中,我们通常需要编写异步函数来处理一些耗时的操作,如网络请求、文件读取等。但是,由于 JavaScript 语言...

    4 年前

相关推荐

    暂无文章