修改网站内容(上周教大家使用docsify搭建一个文档类型网站不?? )
优采云 发布时间: 2022-02-19 00:24修改网站内容(上周教大家使用docsify搭建一个文档类型网站不??
)
还记得我上周发布的 JavaGuide 采访的惊喜版本!它的在线阅读版本来了!“在这个文章中,我保证教你如何使用docsify来构建文档类型网站不是吗?
本 文章 指南将教您如何构建具有如下文档类型的 网站。您可以将其用作项目描述文档,也可以用作自己的小型知识仓库。
官网教程也很详细,地址在这里:#/zh-cn/quickstart,不过我的这个教程更适合实际使用。
下面演示的所有内容的源文件都在这里:
最终效果展示地址:#/
一.先决条件 确保在您的计算机上下载并安装 NPM 并使用以下命令:npm i docsify-cli -g 安装 docsify-cli 工具。确保你有一个 Github 账号(码云账号是可选的,最好有一个)。二.初始化项目并预览
1.新建文件夹:mkdir docsify-demo
2.进入文件夹并运行 docsify init 命令: cd docsify-demo -> docsify init ./
您会在 docsify-demo 文件夹下找到以下文件,一一解释它们为您做了什么!
3.本地预览网站: docsify serve ./ 然后访问: :3000/
三.为我们的项目添加一些颜色
建议克隆我的存储库:,并在本地运行它。这是一个典型的用 docsify 构建的网站,可以作为参考。如果你想建立一个好的文档网站,你可以在我的基础上改变它。
3.1 修改配置文件index.html
主要是配置文件名网站,启用一些配置选项。
html><br /><br /><br /><br /> <br /> docsify-demotitle><br /> <br /> <br /> <br /> <br />head><br /><br /><br /> div><br /> <br /> script><br /> window.$docsify = {name: 'docsify-demo',repo: 'https://github.com/Snailclimb/JavaGuide-Interview',maxLevel: 5,//最大支持渲染的标题层级<br /> subMaxLevel: 3,homepage: 'README.md',coverpage: true,loadSidebar: true,auto2top: true,//切换页面后是否自动跳转到页面顶部<br /> }script><br /> script><br />body><br /><br />html><br />
3.2 添加侧边栏文件
第一步,我们打开了侧边栏选项:
loadSidebar: true<br />
然而,这还不够,我们需要定义一个名为_sidebar.md的文件,文件的内容就是我们侧边栏的内容。
如下图所示,我们定义一个侧边栏并添加一些内容:
一般建议将文档放在docs文件下,可以参考我的仓库:
修改完成后,你会发现我们的文档网站多了个侧边栏,点击后右侧会显示侧边栏对应的内容。
3.3 修改首页内容
修改REDME.md,内容如下:
那么我们文档网站的首页就变成了这样:
3.4 添加封面
第一步,我们开启了封面选项:
coverpage: true<br />
为了让我们的文档 网站 有封面,我们还需要创建一个名为 _coverpage.md 的新文件,其内容如下
那么,当我们打开网站的时候,就会出现一个封面,如下图:
四.一些有用的插件
简单介绍几个我觉得比较实用的插件。更多插件在这里:#/zh-cn/plugins。
4.1 添加Java代码高亮
手动导入 Java 代码高亮插件:
<br />script><br />
4.2 增加全文搜索功能
导入插件:
<br />
配置它: