首页 程序笔记 Docsify | 轻量级无静态构建文档站点生成器

Docsify | 轻量级无静态构建文档站点生成器

什么是 Docsify?

Docsify 可以即时生成你的文档网站。与 GitBook 不同,它不会生成静态 html 文件。相反,它会智能地加载和解析你的 Markdown 文件并将其显示为网站。要开始使用它,你需要做的就是创建一个 index.html 并将其部署在 GitHub Pages 上。

Docsify 官网地址:https://docsify.js.org/

Docsity GitHub地址:https://github.com/docsifyjs/docsify

Docsify 的功能

无需静态构建的 html 文件 简洁轻量 智能全文搜索插件 多种主题 实用的插件 API 支持表情符号 兼容 IE11 支持服务器端渲染(示例)

Docsify 的使用方法

快速开始

使用npm install命令安装Docsify,建议全局安装 docsify-cli,这有助于本地初始化和预览网站。

npm i docsify-cli -g

初始化

如果要在 ./docs 子目录中写入文档,可以使用 init 命令。

docsify init ./docs

编写内容

init完成后,可以在./docs子目录中看到文件列表。

index.html作为入口文件 README.md作为首页 .nojekyll防止GitHub Pages忽略以下划线开头的文件

你可以轻松地在./docs/README.md中更新文档,当然你可以添加更多页面。

预览你的网站

使用 docsify serve 运行本地服务器。可以在浏览器中通过 http://localhost:3000 预览你的网站。

docsify serve docs

手动初始化

如果你不喜欢 npm 或者在安装该工具时遇到困难,你可以手动创建 index.html:

<!-- index.html -->

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
    <meta name="viewport" content="width=device-width,initial-scale=1" />
    <meta charset="UTF-8" />
    <link
      rel="stylesheet"
      href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css"
    />
  </head>
  <body>
    <div id="app"></div>
    <script>
      window.$docsify = {
        //...
      };
    </script>
    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
  </body>
</html>

指定 docsify 版本

请注意,在下面的两个示例中,当发布新的 docsify 主要版本时(例如 v4.x.x => v5.x.x),docsify URL 都需要手动更新。定期检查 docsify 网站以查看是否发布了新的主要版本。

在 URL 中指定主要版本 (@4) 将允许你的网站自动接收非破坏性增强功能(即“次要”更新)和错误修复(即“补丁”更新)。这是加载 docsify 资源的推荐方式。

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>

如果你希望将 docsify 锁定到特定版本,请在 URL 中的 @ 符号后指定完整版本。这是确保你的网站无论对 docsify 的未来版本进行何种更改都保持相同外观和行为的最安全方法。

<link
  rel="stylesheet"
  href="//cdn.jsdelivr.net/npm/docsify@4.11.4/themes/vue.css"
/>
<script src="//cdn.jsdelivr.net/npm/docsify@4.11.4"></script>

手动预览你的网站

如果你的系统上安装了 Python,你可以轻松地使用它来运行静态服务器来预览你的网站。

cd docs && python -m SimpleHTTPServer 3000

cd docs && python -m http.server 3000

加载对话框

如果你愿意,你可以在 docsify 开始呈现文档之前显示加载对话框:

<!-- index.html -->

<div id="app">Please wait...</div>

如果你改变了 el,则应该设置 data-app 属性:

<!-- index.html -->

<div data-app id="main">Please wait...</div>

<script>
  window.$docsify = {
    el: '#main',
  };
</script>

更多设置请参考 Docsify官方文档。

站心网

什么是 Docsify? Docsify 可以即时生成你的文档网站。与 GitBook 不同,它不会生成静态 html 文件。相反,..

为您推荐

连开三国!TikTok Shop 官宣即将开放德、意、法三大新站点

TikTok Shop 正式宣布,将于 2025 年 3 月 31 日正式开放德国、意大利、法国站点,继 2024 年 12 月 TikTok Shop 在西班牙和爱尔兰上线后,这是平台在欧洲市场的又一重要扩张。面对美国市场的不确定性,TikTok Shop ..

在线微信聊天生成器,微信对话生成器_段子手值得拥有的搞笑工具

在网上冲浪,享受网络世界里源源不断的信息时,大家一定看到过各种各样的聊天截图,有搞笑的各种段子、爆料、或者是当事人的回复,以及许多奇奇怪怪的聊天内容,大家在觉得有趣的同时,肯定也想过这些聊天界面的信息..

国内无法访问GitHub的7个解决方法

国内访问 GitHub 可能会遇到访问缓慢、无法加载甚至被 DNS 劫持等问题,以下是几种解决方法:1. 修改 Hosts(适用于网页访问 GitHub)可以手动修改 hosts 文件,将 GitHub 的 IP 地址直连,以绕过 DNS 解析问题。操..

基于Dapper的开源Lambda扩展,且支持分库分表自动生成实体之基础

LnskyDB是基于Dapper的Lambda扩展,支持按时间分库分表,也可以自定义分库分表方法.而且可以T4生成实体类免去手写实体类的烦恼.文档地址:https://liningit.github.io/LnskyDB/开源地址:https://github.com/liningit/Ln..

使用System.Linq.Dynamic.Core扩展库动态构建 LINQ 查询

System.Linq.Dynamic.Core 是一个扩展库,用于在运行时动态构建 LINQ 查询,支持字符串形式的表达式解析和动态查询操作。它是 .NET 的一个强大工具,适合处理需要灵活定义查询逻辑的场景,例如动态过滤、排序、投影..

IIS站点里的application能获取主站点的session吗?

在 IIS 中,主站点和其下的 Application 通常被视为独立的应用程序实例。默认情况下,主站点和子应用程序无法共享 Session 数据,因为它们各自运行在独立的应用程序池中,使用独立的会话状态管理。无法共享Session的..

PluginCore 基于 ASP.NET Core 的轻量级插件框架

项目概述PluginCore 是一个基于 ASP.NET Core 的轻量级插件框架,旨在简化插件的集成与管理。通过最少的配置,开发者可以快速集成并专注于业务逻辑的开发。它支持动态 WebAPI、插件隔离与共享、前后端分离、热插拔等..

使用shields.io来实时显示GitHub项目star、watch和fork的数量

如何获取GitHub repo实时的star,watch和fork数量呢?这里推荐一个Shields.io工具,可以实时生成GitHub徽章,同时显示star数。显示效果如下:什么是 Shields.io?Shields.io 是一个开源项目,用于生成各种类型的徽章..

GitHub上开源许可证License含义说明

在 GitHub 上,开源许可证规定了其他人如何使用、修改和分发代码。以下是几种常见的开源许可证及其含义:MIT 许可证:MIT 许可证是非常宽松的许可证,允许任何人自由使用、复制、修改和分发代码。唯一的要求是保留原..

微软 .NET 9 正式发布!专为云原生和生成式 AI 应用设计

微软正式发布了 .NET 9,这是一次重大的版本更新。微软在 .NET 9 中带来了一系列新特性和改进,主要聚焦在性能优化、云原生支持、AI集成以及开发者体验的提升。以下是一些重要的更新亮点:性能改进:在 .NET 9 中,..

HTQL 提取和查询HTML和XML数据的轻量级查询语言

HTQL(Hyper-Text Query Language)是一种用于提取和查询HTML和XML数据的轻量级查询语言。HTQL提供类似SQL的语法,可以方便地从网页或其他基于标签的文档中提取结构化数据,而无需解析整个文档。这使得它在爬虫、数..

轻量级 JavaScript 动画库 mo.js使用教程

mo.js 是一个强大的 JavaScript 动画库,专为在网页项目中创建复杂动画和运动图形而设计。它注重提供平滑、动态的动画效果,并通过简单、模块化和灵活的组件让开发更加便捷。mo.js官网地址:https://mojs.github.io/..

ideogram.ai 人工智能AI图片生成工具网站

Ideogram是一个由前Google Brain员工创立的AI绘画工具,它能够根据文本生成各种风格的图像,尤其擅长准确生成文本内容和抽象图标。Ideogram官网地址:https://ideogram.ai/loginIdeogram是由前Google Brain员工在202..

.NET 9 即将推出的功能Task.WhenEach

.NET 爱好者!我刚刚偶然发现了一个非常酷的新 PR,它被合并到 .NET 运行时存储库中,我想分享一个例子。希望您能为新的 .NET 版本大肆宣传!在即将到来的 .NET 9 版本中,我们预计会有一个名为 .它在这里让您的异步..

针对 Go 语言开发的 SQL 驱动模拟库

数据库交互是几乎所有应用程序不可或缺的一部分,开发者们常常需要对数据库进行各种操作,包括插入、更新、删除和查询等。然而,在开发过程中直接对真实数据库进行操作不仅耗时耗力,还可能带来数据一致性和安全性的..

DockerUI 中文可视化Docker管理工具使用示例

DockerUI 是由国内开发者打造的一款优秀的 Docker 可视化管理工具。该工具拥有简洁直观的UI界面,可以轻松进行Docker主机管理、集群管理,以及Docker任务的编排等操作。DockerUI不仅展示了资源利用率、系统信息和更..

Blazor的N种渲染模式原理和常见问题说明

我们从下面这幅图开始,下图显示了三种渲染模式,分别称之为静态SSR、交互式SSR(即之前的BlazorServer)、交互式CSR(即之前的BlazorWasm)。还有一种渲染模式BlazorHybrid,稍后说。一、先浅层理解一个图例静态SSR:经..

前端CSS常见的三种设计模式

CSS设计模式主要包括OOCSS、SMACSS和BEMCSS等。以下是对这些模式的具体介绍:OOCSS:面向对象的CSS,旨在编写高可复用、低耦合和高扩展的CSS代码。它将抽象(结构)和实现(样式)分离,抽离公共代码,以提高代码的..

WinToUSB | 把Windows塞进U盘里即插即用

不论是在外出差,还是在家临时办公,现在很多设备携带起来都不是那么方便,在这种情况下,有一个轻巧而高效的操作系统环境就显得格外关键。今天,要给大家介绍一款超级实用的便携式系统启动盘,凭借其独特功能和卓越..

.NET Framework被淘汰了吗?

.NET Framework并未完全被淘汰,但它的某些版本确实已经停止支持。微软在2023年11月10日停止了对.NET Framework 4.8之前的版本的支持。这一决策意味着使用这些旧版本的应用程序将不再获得安全更新和其他维护,从而可..

发表回复

返回顶部