用MarkDown 生成网站

 docsify

初始化安装项目

全局安装

# 全局安装docsify-cli
npm i docsify-cli -g

初始化项目

# 初始化docs目录
docsify init ./docs

启动项目

# 启动项目
docsify serve docs

注意:docs为文件夹名称,需要在文件夹外启动

 CDN

<!-- 引入 css -->
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4.10.2/themes/vue.css">

<!-- 引入 script -->
<script src="//cdn.jsdelivr.net/npm/docsify@4.10.2/lib/docsify.js"></script>

其他cdn

 侧边栏添加

加载自定义侧边栏,设置为 true 后会加载 _sidebar.md 文件,也可以自定义加载的文件名。

window.$docsify = {
  // 加载 _sidebar.md
  loadSidebar: true,

  // 加载 summary.md
  loadSidebar: '_sidebar.md',
};

 _sidebar.md文件

* 入门
  * [快速开始](quickstart.md)
  * [多页文档](more-pages.md)
  * [定制导航栏](custom-navbar.md)
  * [封面](cover.md)

* 定制化
  * [配置项](configuration.md)
  * [主题](themes.md)
  * [插件列表](plugins.md)
  * [代码高亮](language-highlight.md)

插件

表情插件

index.html中新增:

<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script>

:100: => 💯

搜索插件

index.html中新增:

<script>
  window.$docsify = {
    search: 'auto',  // 默认 auto
  }
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>

<script>
  window.$docsify = {
    // 设置后只搜索这几个目录
    search : [
      '/',            // => /README.md
      '/guide',       // => /guide.md
      '/get-started', // => /get-started.md
      '/zh-cn/',      // => /zh-cn/README.md
    ]
  }
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>

<script>
  window.$docsify = {
    search: {
      maxAge: 86400000,     // 到期时间
      paths: [],             // 可以设置搜索的目录
      placeholder: 'Type to search',    // 搜索框提示
      noData: 'No Results!',    // 无结果时显示的文字
      depth: 2,    // 深度
      hideOtherSidebarContent: false,    // .隐藏其他侧边栏内容
    }
  }
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>

 图片缩放插件

在index.html中新增

<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>

 

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

lv_longcheng

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值