技术文档收录
ASCII
Tcpdump
IPV4保留地址段
深入理解以太网网线原理 - 三帛的世界
Linux
WireGuard 一键安装脚本 | 秋水逸冰
SSH Config 那些你所知道和不知道的事 | Deepzz's Blog
Linux 让终端走代理的几种方法
ubuntu 20.04 server 版设置静态 IP 地址 - 链滴
Linux 挂载 Windows 共享磁盘的方法 - 技术学堂
将 SMB/CIFS 网络硬盘永久的挂载到 Ubuntu 上 - 简书
linux 获取当前脚本的绝对路径 | aimuke
[Linux] Linux 使用 / dev/urandom 生成随机数 - piaohua's blog
Linux 生成随机数的多种方法 | Just Do It
Linux 的 Centos7 版本下忘记 root 或者普通用户密码怎么办?
Git 强制拉取覆盖本地
SSH 安全加固指南 - FreeBuf 网络安全行业门户
Linux 系统安全强化指南 - FreeBuf 网络安全行业门户
Linux 入侵排查 - FreeBuf 网络安全行业门户
sshd_config 配置详解 - 简书
SSH 权限详解 - SegmentFault 思否
CentOS 安装 node.js 环境 - SegmentFault 思否
如何在 CentOS 7 上安装 Node.js 和 npm | myfreax
几款 ping tcping 工具总结
OpenVpn 搭建教程 | Jesse's home
openvpn 一键安装脚本 - 那片云
OpenVPN 解决 每小时断线一次 - 爱开源
OpenVPN 路由设置 – 凤曦的小窝
OpenVPN 设置非全局代理 - 镜子的记录簿
TinyProxy 使用帮助 - 简书
Ubuntu 下使用 TinyProxy 搭建代理 HTTP 服务器_Linux_运维开发网_运维开发技术经验分享
Linux 软件包管理工具 Snap 常用命令 - 简书
linux systemd 参数详解
Systemd 入门教程:命令篇 - 阮一峰的网络日志
记一次 Linux 木马清除过程
rtty:在任何地方通过 Web 访问您的终端
02 . Ansible 高级用法 (运维开发篇)
终于搞懂了服务器为啥产生大量的 TIME_WAIT!
巧妙的 Linux 命令,再来 6 个!
77% 的 Linux 运维都不懂的内核问题,这篇全告诉你了
运维工程师必备:请收好 Linux 网络命令集锦
一份阿里员工的 Java 问题排查工具单
肝了 15000 字性能调优系列专题(JVM、MySQL、Nginx and Tomcat),看不完先收
作业调度算法(FCFS,SJF,优先级调度,时间片轮转,多级反馈队列) | The Blog Of WaiterXiaoYY
看了这篇还不会 Linux 性能分析和优化,你来打我
2019 运维技能风向标
更安全的 rm 命令,保护重要数据
求你了,别再纠结线程池大小了!
Linux sudo 详解 | 失落的乐章
重启大法好!线上常见问题排查手册
sudo 使用 - 笨鸟教程的博客 | BY BenderFly
shell 在手分析服务器日志不愁? - SegmentFault 思否
sudo 与 visudo 的超细用法说明_陈发哥 007 的技术博客_51CTO 博客
ESXI 下无损扩展 Linux 硬盘空间 | Naonao Blog
Linux 学习记录:su 和 sudo | Juntao Tan 的个人博客
使用者身份切换 | Linux 系统教程(笔记)
你会使用 Linux 编辑器 vim 吗?
在 Windows、Linux 和 Mac 上查看 Wi-Fi 密码
linux 隐藏你的 crontab 后门 - 简书
Linux 定时任务详解 - Tr0y's Blog
linux 的 TCP 连接数量最大不能超过 65535 个吗,那服务器是如何应对百万千万的并发的?_一口 Linux 的博客 - CSDN 博客_tcp 连接数多少正常
万字长文 + 28 张图,一次性说清楚 TCP,运维必藏
为什么 p2p 模式的 tunnel 底层通常用 udp 而不是 tcp?
记一次服务器被入侵挖矿 - tlanyan
shell 判断一个变量是否为空方法总结 - 腾讯云开发者社区 - 腾讯云
系统安装包管理工具 | Escape
编译代码时动态地链接库 - 51CTO.COM
甲骨文 Oracle Cloud 添加新端口开放的方法 - WirelessLink 社区
腾讯云 Ubuntu 添加 swap 分区的方法_弓弧名家_玄真君的博客 - CSDN 博客
Oracle 开放全部端口并关闭防火墙 - 清~ 幽殇
谁再说不熟悉 Linux 命令, 就把这个给他扔过去!
即插即用,运维工程师必会正则表达式大全
Shell脚本编写及常见面试题
Samba 文件共享服务器
到底一台服务器上最多能创建多少个 TCP 连接 | plantegg
SSH 密钥登录 - SSH 教程 - 网道
在 Bash 中进行 encodeURIComponent/decodeURIComponent | Harttle Land
使用 Shell 脚本来处理 JSON - Tom CzHen's Blog
Docker
「Docker」 - 保存镜像 - 知乎
终于可以像使用 Docker 一样丝滑地使用 Containerd 了!
私有镜像仓库选型:Harbor VS Quay - 乐金明的博客 | Robin Blog
exec 与 entrypoint 使用脚本 | Mr.Cheng
Dockerfile 中的 CMD 与 ENTRYPOINT
使用 Docker 配置 MySQL 主从数据库 - 墨天轮
Alpine vs Distroless vs Busybox – 云原生实验室 - Kubernetes|Docker|Istio|Envoy|Hugo|Golang | 云原生
再见,Docker!
docker save 与 docker export 的区别 - jingsam
如何优雅的关闭容器
docker 储存之 tmpfs 、bind-mounts、volume | 陌小路的个人博客
Dockerfile 中 VOLUME 与 docker -v 的区别是什么 - 开发技术 - 亿速云
理解 docker 容器的退出码 | Vermouth | 博客 | docker | k8s | python | go | 开发
【Docker 那些事儿】容器监控系统,来自 Docker 的暴击_飞向星的客机的博客 - CSDN 博客
【云原生】Docker 镜像详细讲解_微枫 Micromaple 的博客 - CSDN 博客_registry-mirrors
【云原生】Helm 架构和基础语法详解
CMD 和 Entrypoint 命令使用变量的用法
实时查看容器日志 - 苏洋博客
Traefik 2 使用指南,愉悦的开发体验 - 苏洋博客
为你的 Python 应用选择一个最好的 Docker 映像 | 亚马逊 AWS 官方博客
【云原生】镜像构建实战操作(Dockerfile)
Docker Compose 中的 links 和 depends_on 的区别 - 编程知识 - 白鹭情
Python
Pipenv:新一代Python项目环境与依赖管理工具 - 知乎
Python list 列表实现栈和队列
Python 各种排序 | Lesley's blog
Python 中使用 dateutil 模块解析时间 - SegmentFault 思否
一个小破网站,居然比 Python 官网还牛逼
Python 打包 exe 的王炸 - Nuitka
Django - - 基础 - - Django ORM 常用查询语法及进阶
[Python] 小知識:== 和 is 的差異 - Clay-Technology World
Window
批处理中分割字符串 | 网络进行时
Windows 批处理基础命令学习 - 简书
在Windows上设置WireGuard
Windows LTSC、LTSB、Server 安装 Windows Store 应用商店
windows 重启 rdpclip.exe 的脚本
中间件
Nginx 中的 Rewrite 的重定向配置与实践
RabbitMQ 的监控
RabbitMq 最全的性能调优笔记 - SegmentFault 思否
为什么不建议生产用 Redis 主从模式?
高性能消息中间件——NATS
详解:Nginx 反代实现 Kibana 登录认证功能
分布式系统关注点:仅需这一篇,吃透 “负载均衡” 妥妥的
仅需这一篇,妥妥的吃透” 负载均衡”
基于 nginx 实现上游服务器动态自动上下线——不需 reload
Nginx 学习书单整理
最常见的日志收集架构(ELK Stack)
分布式之 elk 日志架构的演进
CAT 3.0 开源发布,支持多语言客户端及多项性能提升
Kafka 如何做到 1 秒处理 1500 万条消息?
Grafana 与 Kibana
ELK 日志系统之通用应用程序日志接入方案
ELK 简易 Nginx 日志系统搭建: ElasticSearch+Kibana+Filebeat
记一次 Redis 连接池问题引发的 RST
把 Redis 当作队列来用,你好大的胆子……
Redis 最佳实践:业务层面和运维层面优化
Redis 为什么变慢了?常见延迟问题定位与分析
好饭不怕晚,扒一下 Redis 配置文件的底 Ku
rabbitmq 集群搭建以及万级并发下的性能调优
别再问我 Redis 内存满了该怎么办了
Nginx 状态监控及日志分析
uWSGI 的安装及配置详解
uwsgi 异常服务器内存 cpu 爆满优化思路
Uwsgi 内存占用过多 - 简书
Nginx 的 limit 模块
Nginx 内置模块简介
Redis 忽然变慢了如何排查并解决?_redis_码哥字节_InfoQ 写作社区
领导:谁再用 redis 过期监听实现关闭订单,立马滚蛋!
Nginx 限制 IP 访问频率以及白名单配置_问轩博客
Nginx $remote_addr 和 $proxy_add_x_forwarded_for 变量详解
Caddy 部署实践
一文搞定 Nginx 限流
数据库
SqlServer 将数据库中的表复制到另一个数据库_MsSql_脚本之家
SQL Server 数据库同步,订阅、发布、复制、跨服务器
sql server 无法删除本地发布 | 辉克's Blog
SQLite全文检索
SQL 重复记录查询的几种方法 - 简书
SQL SERVER 使用订阅发布同步数据库(转)
Mysql 查看用户连接数配置及每个 IP 的请求情况 - 墨天轮
优化 SQL 的 21 条方案
SQL Server 连接时好时坏的奇怪问题
MS SQL 执行大脚本文件时,提示 “内存不足” 的解决办法 - 阿里云开发者社区
防火墙-iptables
iptables 常用规则:屏蔽 IP 地址、禁用 ping、协议设置、NAT 与转发、负载平衡、自定义链
防火墙 iptables 企业防火墙之 iptables
Linux 防火墙 ufw 简介
在 Ubuntu 中用 UFW 配置防火墙
在 Ubuntu20.04 上怎样使用 UFW 配置防火墙 - 技术库存网
监控类
开箱即用的 Prometheus 告警规则集
prometheus☞搭建 | zyh
docker 部署 Prometheus 监控服务器及容器并发送告警 | chris'wang
PromQL 常用命令 | LRF 成长记
prometheus 中使用 python 手写 webhook 完成告警
持续集成CI/CD
GitHub Actions 的应用场景 | 记录干杯
GithubActions · Mr.li's Blog
工具类
GitHub 中的开源网络广告杀手,十分钟快速提升网络性能
SSH-Auditor:一款 SHH 弱密码探测工具
别再找了,Github 热门开源富文本编辑器,最实用的都在这里了 - srcmini
我最喜欢的 CLI 工具
推荐几款 Redis 可视化工具
内网代理工具与检测方法研究
环境篇:数据同步工具 DataX
全能系统监控工具 dstat
常用 Web 安全扫描工具合集
给你一款利器!轻松生成 Nginx 配置文件
教程类
Centos7 搭建神器 openvpn | 运维随笔
搭建 umami 收集个人网站统计数据 | Reorx’s Forge
openvpn安装教程
基于 gitea+drone 完成小团队的 CI/CD - 德国粗茶淡饭
将颜色应用于交替行或列
VMware Workstation 全系列合集 精简安装注册版 支持 SLIC2.6、MSDM、OSX 更新 16.2.3_虚拟机讨论区_安全区 卡饭论坛 - 互助分享 - 大气谦和!
在 OpenVPN 上启用 AD+Google Authenticator 认证 | 运维烂笔头
Github 进行 fork 后如何与原仓库同步:重新 fork 很省事,但不如反复练习版本合并 · Issue #67 · selfteaching/the-craft-of-selfteaching
卧槽,VPN 又断开了!!- 阿里云开发者社区
Grafana Loki 学习之踩坑记
zerotier 的 planet 服务器(根服务器)的搭建踩坑记。无需 zerotier 官网账号。
阿里云 qcow2 镜像转 vmdk,导入 ESXi - 唐际忠的博客
Caddy 入门 – 又见杜梨树
【Caddy2】最新 Caddy2 配置文件解析 - Billyme 的博客
Web 服务器 Caddy 2 | Haven200
手把手教你打造高效的 Kubernetes 命令行终端
Keras 作者:给软件开发者的 33 条黄金法则
超详细的网络抓包神器 Tcpdump 使用指南
使用 fail2ban 和 FirewallD 黑名单保护你的系统
linux 下 mysql 数据库单向同步配置方法分享 (Mysql)
MySQL 快速删除大量数据(千万级别)的几种实践方案
GitHub 上的优质 Linux 开源项目,真滴牛逼!
WireGuard 教程:使用 Netmaker 来管理 WireGuard 的配置 – 云原生实验室 - Kubernetes|Docker|Istio|Envoy|Hugo|Golang | 云原生
Tailscale 基础教程:Headscale 的部署方法和使用教程 – 云原生实验室 - Kubernetes|Docker|Istio|Envoy|Hugo|Golang | 云原生
Nebula Graph 的 Ansible 实践
改进你的 Ansible 剧本的 4 行代码
Caddy 2 快速简单安装配置教程 – 高玩梁的博客
切换至 Caddy2 | 某不科学的博客
Caddy2 简明教程 - bleem
树莓派安装 OpenWrt 突破校园网限制 | Asttear's Blog
OpenVPN 路由设置 – 凤曦的小窝
个性化编译 LEDE 固件
盘点各种 Windows/Office 激活工具
[VirtualBox] 1、NAT 模式下端口映射
VirtualBox 虚拟机安装 openwrt 供本机使用
NUC 折腾笔记 - 安装 ESXi 7 - 苏洋博客
锐捷、赛尔认证 MentoHUST - Ubuntu 中文
How Do I Use A Client Certificate And Private Key From The IOS Keychain? | OpenVPN
比特记事簿: 笔记: 使用电信 TR069 内网架设 WireGuard 隧道异地组网
利用 GitHub API 获取最新 Releases 的版本号 | 这是只兔子
docsify - 生成文档网站简单使用教程 - SegmentFault 思否
【干货】Chrome 插件 (扩展) 开发全攻略 - 好记的博客
一看就会的 GitHub 骚操作,让你看上去像一位开源大佬
【计算机网络】了解内网、外网、宽带、带宽、流量、网速_墩墩分墩 - CSDN 博客
mac-ssh 配置 | Sail
如何科学管理你的密码
VirtualBox NAT 端口映射实现宿主机与虚拟机相互通信 | Shao Guoliang 的博客
CentOS7 配置网卡为静态 IP,如果你还学不会那真的没有办法了!
laisky-blog: 近期折腾 tailscale 的一些心得
使用 acme.sh 给 Nginx 安装 Let’ s Encrypt 提供的免费 SSL 证书 · Ruby China
acme 申请 Let’s Encrypt 泛域名 SSL 证书
从 nginx 迁移到 caddy
使用 Caddy 替代 Nginx,全站升级 https,配置更加简单 - Diamond-Blog
http.proxy - Caddy 中文文档
动手撸个 Caddy(二)| Caddy 命令行参数最全教程 | 飞雪无情的总结
Caddy | 学习笔记 - ijayer
Caddy 代理 SpringBoot Fatjar 应用上传静态资源
使用 graylog3.0 收集 open××× 日志进行审计_年轻人,少吐槽,多搬砖的技术博客_51CTO 博客
提高国内访问 github 速度的 9 种方法! - SegmentFault 思否
VM16 安装 macOS 全网最详细
2022 目前三种有效加速国内 Github
How to install MariaDB on Alpine Linux | LibreByte
局域网内电脑 - ipad 文件共享的三种方法 | 岚
多机共享键鼠软件横向测评 - 尚弟的小笔记
VLOG | ESXI 如何升级到最新版,无论是 6.5 还是 6.7 版本都可以顺滑升级。 – Vedio Talk - VLOG、科技、生活、乐分享
远程修改 ESXi 6.7 管理 IP 地址 - 腾讯云开发者社区 - 腾讯云
几乎不要钱自制远程 PLC 路由器方案
traefik 简易入门 | 个人服务器运维指南 | 山月行
更完善的 Docker + Traefik 使用方案 - 苏洋博客
MicroSD·TF 卡终极探秘 ·MLC 颗粒之谜 1 三星篇_microSD 存储卡_什么值得买
macOS 绕过公证和应用签名方法 - 走客
MiscSecNotes / 内网端口转发及穿透. md at master · JnuSimba/MiscSecNotes
我有特别的 DNS 配置和使用技巧 | Sukka's Blog
SEO:初学者完整指南
通过 OpenVPN 实现流量审计
OpenVPN-HOWTO
OpenVPN Server · Devops Roadmap
Linux 运维必备的 13 款实用工具, 拿好了~
linux 平台下 Tomcat 的安装与优化
Linux 运维跳槽必备的 40 道面试精华题
Bash 脚本进阶,经典用法及其案例 - alonghub - 博客园
推荐几个非常不错的富文本编辑器 - 走看看
在 JS 文件中加载 JS 文件的方法 - 月光博客
#JavaScript 根据需要动态加载脚本并设置自定义参数
笔记本电脑 BIOS 修改及刷写教程
跨平台加密 DNS 和广告过滤 personalDNSfilter · LinuxTOY
AdGuard Home 安装及使用指北
通过 Amazon S3 协议挂载 OSS
记一次云主机如何挂载对象存储
本文档发布于https://mrdoc.fun
-
+
首页
docsify - 生成文档网站简单使用教程 - SegmentFault 思否
> 本文由 [简悦 SimpRead](http://ksria.com/simpread/) 转码, 原文地址 [segmentfault.com](https://segmentfault.com/a/1190000017576714) 1. docsify 介绍 ------------- docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。 这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件 “污染” commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。 2. 引入 docsify 方式 ---------------- ### 2.1 手动创建`index.html`并引入 docsify 文件 docsify 使用方式很简单,只需要在项目中创建一个`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="//unpkg.com/docsify/themes/vue.css"> </head> <body> <div id="app"></div> <script> window.$docsify = { //... } </script> <script src="//unpkg.com/docsify/lib/docsify.min.js"></script> </body> </html> ``` 然后在项目中创建一个`README.md`文件: ``` ## 我是首页 这是我的首页介绍 ``` 如果你的系统安装了 Python 的话,可以使用 Python 来启动一个服务: ``` python -m SimpleHTTPServer 3000 Serving HTTP on 0.0.0.0 port 3000 ... 127.0.0.1 - - [03/Jan/2019 13:45:27] "GET / HTTP/1.1" 200 - ``` ![](https://segmentfault.com/img/bVbmCmR?w=1710&h=278) 然后在浏览器中输入`http://localhost:3000/`查看浏览效果。 如果没有 Python,还是可以使用`http-server`启动服务, 可在终端输入`npm install http-server -g`来安装`http-server`。 ``` http-server Starting up http-server, serving ./ Available on: http://127.0.0.1:8080 http://172.24.70.142:8080 Hit CTRL-C to stop the server ``` ![](https://segmentfault.com/img/bVbmCnz?w=1818&h=394) 然后在浏览器中输入`http://127.0.0.1:8080`查看浏览效果。 ![](https://segmentfault.com/img/bVbmCsw?w=1642&h=572) **_注意:_** 1. 在此模式下编辑文件保存后,需要手动刷新浏览器才能看见修改的效果,下面介绍的`docsify-cli`可实现自动查看效果。 2. 强烈建议把`index.html`文件中的`docsify.min.js`和`vue.css`文件复制到本地项目,然后使用如下方式引入: ``` <link rel="stylesheet" href="./vue.css"> <script src="./docsify.min.js"></script> ``` 这样做的好处是不在依赖网络环境了。 ### 2.2 使用`docsify-cli`来开发 docsify-cli 工具,可以方便创建及本地预览文档网站。 #### 2.2.1 安装 docsify 需要本地先安装`node`, 如果没有安装 node,可在 node 官网选择对应操作系统下载安装:[https://nodejs.org/zh-cn/](https://nodejs.org/zh-cn/) 终端输入`npm i docsify-cli -g`进行全局安装: ``` npm i docsify-cli -g /usr/local/bin/docsify -> /usr/local/lib/node_modules/docsify-cli/bin/docsify > fsevents@1.2.4 install /usr/local/lib/node_modules/docsify-cli/node_modules/fsevents > node install [fsevents] Success: "/usr/local/lib/node_modules/docsify-cli/node_modules/fsevents/lib/binding/Release/node-v57-darwin-x64/fse.node" already installed Pass --update-binary to reinstall or --build-from-source to recompile > docsify@4.8.6 postinstall /usr/local/lib/node_modules/docsify-cli/node_modules/docsify > opencollective postinstall Thanks for installing docsify 🙏 Please consider donating to our open collective to help us maintain this package. 👉 Donate: https://opencollective.com/docsify/donate + docsify-cli@4.3.0 added 456 packages from 206 contributors in 32.827s ``` ![](https://segmentfault.com/img/bVblUH8?w=1452&h=535) 安装结束后使用`docsify -v`查看是否安装成功: ``` docsify -v docsify-cli version: 4.3.0 ``` #### 2.2.2 初始化一个项目 首先需要创建一个项目目录: ``` mkdir docsify ``` 进入项目目录后,使用`docsify init ./`来初始化一个项目: ``` cd docsify docsify init ./ Initialization succeeded! Please run docsify serve ./ ``` ``` tree -a . ├── .nojekyll ├── README.md └── index.html ``` 初始化成功后,`docsify`目录会生成如下几个文件: 1. `index.html`入口文件 2. `README.md`会做为主页内容渲染 3. `.nojekyll`用于阻止 GitHub Pages 会忽略掉下划线开头的文件、 `.nojekyll`文件很重要,如果网站部署到`GitHub Pages`时,一定要注意这个文件。 直接编辑 ./README.md 就能更新网站内容,当然也可以添加其他`.md`文件。 #### 2.2.3 启动本地服务 终端输入`docsify serve ./`来启动服务: ``` docsify serve ./ Serving /Users/dragon/tmp/docsify now. Listening at http://localhost:3000 ``` 然后浏览器打开`http://localhost:3000`就能看见效果。 ![](https://segmentfault.com/img/bVblUJh?w=961&h=267) 当修改文件保存后, `docsify serve ./`服务会自动实时更新。 3. 关于每个页面和 URL 路径说明 ------------------- 如果需要创建多个页面,或者需要多级路由的网站,在`docsify`里也能很容易的实现。例如创建一个`guide.md`文件,那么对应的路由就是`/#/guide`。 如果你的目录结构如下: ``` -| ./ -| README.md -| guide.md -| zh-cn/ -| README.md -| guide.md ``` 那么对应的访问页面将是: ``` ./README.md => http://domain.com ./guide.md => http://domain.com/guide ./zh-cn/README.md => http://domain.com/zh-cn/ ./zh-cn/guide.md => http://domain.com/zh-cn/guide ``` 4. 侧边栏设置 -------- 默认情况下,侧边栏会根据当前文档的标题生成目录。 ![](https://segmentfault.com/img/bVblVgd?w=1238&h=413) ### 4.1 定制侧边栏 首先需要在`index.html`文件中的`window.$docsify`添加`loadSidebar: true,`选项: ``` <script> window.$docsify = { loadSidebar: true } </script> <script src="//unpkg.com/docsify"></script> ``` 接着在项目根目录创建`_sidebar.md`文件,内容格式如下: ``` * [home1](home1) * [home2](home2) * [bar](bar/) * [bar/a](bar/a) ``` ![](https://segmentfault.com/img/bVblVl7?w=1175&h=383) **_注:_**配置了`loadSidebar`后就不会生成默认的侧边栏了。 ### 4.2 关于侧边栏`_sidebar.md`文件的说明 * 如果只在根目录有一个`_sidebar.md`文件,那么所有页面都将使用这个一个配置,也就是所有页面的侧边栏都一样。 * 如果一个子目录中有`_sidebar.md`文件,那么这个子目录下的所有页面将使用这个文件的侧边栏。 * `_sidebar.md`的加载逻辑是从每层目录下获取文件,如果当前目录不存在该文件则回退到上一级目录。例如当前路径为`/zh-cn/more-pages`则从`/zh-cn/_sidebar.md`获取文件,如果不存在则从`/_sidebar.md`获取。 如果子目录有`_sidebar.md`, 但你就想使用根目录的`_sidebar.md`, 可在`index.html`文件中的`window.$docsify`添加`alias`字段: ``` <script> window.$docsify = { loadSidebar: true, alias: { '/.*/_sidebar.md': '/_sidebar.md' } } </script> ``` 配置`alias`字段后,所有页面都会显示项目根目录`_sidebar.md`文件的配置作为侧边栏,子目录的`_sidebar.md`文件会失效。 ### 4.3 显示页面目录 (当前页面的标题) 定制的侧边栏仅显示了页面的链接。 还可以设置在侧边栏显示当前页面的目录 (标题)。 需要在`index.html`文件中的`window.$docsify`添加`subMaxLevel`字段来设置: ``` <script> window.$docsify = { loadSidebar: true, subMaxLevel: 3 } </script> <script src="//unpkg.com/docsify"></script> ``` ![](https://segmentfault.com/img/bVbmiKc?w=1322&h=554) subMaxLevel 说明: subMaxLevel 类型是 number(数字),表示显示的目录层级 **注意:**如果 md 文件中的第一个标题是一级标题,那么不会显示在侧边栏,如上图所示 <table><thead><tr><th>值</th><th>说明</th></tr></thead><tbody><tr><td>0</td><td>默认值,表示不显示目录</td></tr><tr><td>1</td><td>显示一级标题 (<code>h1</code>)</td></tr><tr><td>2</td><td>显示一、二级标题 (<code>h1</code> ~ <code>h2</code>)</td></tr><tr><td>3</td><td>显示一、二、三级标题 (<code>h1</code> ~ <code>h3</code>)</td></tr><tr><td>n</td><td>n 是数字,显示一、二、....n 级标题 (<code>h1</code> ~ <code>hn</code>)</td></tr></tbody></table> 在 md 文件中标题的写法: ``` # 这是一级标题,对应HTML中<h1>标签 ## 这是二级标题,对应HTML中<h2>标签 ### 这是三级标题,对应HTML中<h3>标签 #### 这是四级标题,对应HTML中<h4>标签 ``` #### 4.3.1 页面的标题不在侧边栏目录显示 **_注意:_** 如果 md 文件的第一个标题是一级标题,那么默认已经忽略了。 当设置了 subMaxLevel 时,默认情况下每个标题都会自动添加到目录中。如果你想忽略特定的标题,可以给它添加 {docsify-ignore} : ``` # Getting Started ## Header {docsify-ignore} 该标题不会出现在侧边栏的目录中。 ``` 要忽略特定页面上的所有标题,你可以在页面的第一个标题上使用 {docsify-ignore-all} : ``` # Getting Started {docsify-ignore-all} ## Header 该页面所有标题都不会出现在侧边栏的目录中。 ``` 在使用时, {docsify-ignore} 和 {docsify-ignore-all} 都不会在页面上显示。 5. 导航栏配置 -------- docsify 默认是没有导航栏的,可以通过配置来显示导航栏。 ### 5.1 在`index.html`中定义导航栏 如果导航的链接少,则可以直接在`index.html`文件直接定义导航栏,要注意链接要以`#/`开头: ``` <body> <nav> <a href="#/">项目</a> <a href="#/home1">home1</a> <a href="#/bar/a">bar/a</a> </nav> </body> ``` ![](https://segmentfault.com/img/bVbmne6?w=1398&h=367) ### 5.2 通过配置文件定义导航栏 首先需要在`index.html`文件中的`window.$docsify`添加`loadNavbar: true,`选项: ``` <script> window.$docsify = { loadNavbar: true } </script> <script src="//unpkg.com/docsify"></script> ``` 接着在项目根目录创建`_navbar.md`文件,内容格式如下: ``` * [home1](home1) * [home2](home2) * [bar](bar/) * [bar/a](bar/a) ``` ![](https://segmentfault.com/img/bVbmorU?w=1292&h=391) **_注意:_** 1. 如果使用配置文件来设置导航栏,那么在`index.html`中定义的导航栏只有在定制的首页才会生效,其他页面会被覆盖。 2. 如果只在根目录有一个`_navbar.md`文件,那么所有页面都将使用这个一个配置,也就是所有页面的导航栏都一样。 3. 如果一个子目录中有`_navbar.md`文件,那么这个子目录下的所有页面将使用这个文件的导航栏。 4.`_navbar.md`的加载逻辑是从每层目录下获取文件,如果当前目录不存在该文件则回退到上一级目录。例如当前路径为`/zh-cn/more-pages`则从`/zh-cn/_navbar.md`获取文件,如果不存在则从`/_navbar.md`获取。 ### 5.3 导航栏嵌套 如果导航内容过多,可以写成嵌套的列表,会被渲染成下拉列表的形式: ``` * 根目录 * [home1](home1) * [home2](home2) * [guide](guide) * bar目录 * [bar](bar/) * [a文件](bar/a) * [b文件](bar/b) * foo目录 * [one](foo/one) ``` ![](https://segmentfault.com/img/bVbmpJQ?w=1251&h=404) 6. 设置封面 ------- docsify 默认是没有封面的,默认有个首页`./README.md`。 通过设置`coverpage`参数,可以开启渲染封面的功能。 首先需要在`index.html`文件中的`window.$docsify`添加`coverpage: true`选项: ``` <script> window.$docsify = { coverpage: true } </script> <script src="//unpkg.com/docsify"></script> ``` 接着在项目根目录创建`_coverpage.md`文件,内容格式如下: ``` ![logo](_media/icon.svg) # 我的文档网站 ## 个人文档网站 > 一个神奇的文档网站生成巩固 * Simple and lightweight (~12kb gzipped) * Multiple themes * Not build static html files [GitHub](https://github.com/docsifyjs/docsify/) [Get Started](#quick-start) [Get Started](#quick-start) ``` ![](https://segmentfault.com/img/bVbmwnO?w=1467&h=653) **_注:_**一份文档只会在根目录下加载封面,其他页面或者二级目录下都不会加载。 #### 6.1 自定义封面背景 目前的背景是随机生成的渐变色,每次刷新都会显示不同的颜色。 docsify 封面支持自定义背景色或者背景图,在`_coverpage.md`文档末尾添加: ``` <!-- 背景图片 --> ![](_media/bg.png) <!-- 背景色 --> ![color](#2f4253) ``` ![](https://segmentfault.com/img/bVbmwp2?w=1244&h=446) **_注意:_** 1. 自定义背景配置一定要在`_coverpage.md`文档末尾。 2. 背景图片和背景色只能有一个生效. 3. 背景色一定要是`#2f4253`这种格式的。 #### 6.2 把封面作为首页 配置了封面后,封面和首页是同时出现的,封面在上面,首页在下面。 通过设置`onlyCover`参数,可以让 docsify 网站首页只显示封面, 原来的首页通过`http://localhost:3000/#/README`访问。 在`index.html`文件中的`window.$docsify`添加`onlyCover: true,`选项: ``` <script> window.$docsify = { coverpage: true, onlyCover: true, } </script> <script src="./docsify.min.js"></script> ``` 通过此配置可以把`./README.md`文件独立出来,当成项目真正的 README 介绍文件。 #### 6.3 多个封面 如果你的文档网站是多语言的,或许你需要设置多个封面。 例如你的文档目录结构如下 ``` . └── docs ├── README.md ├── guide.md ├── _coverpage.md └── zh-cn ├── README.md └── guide.md └── _coverpage.md ``` 那么你可以在`index.html`文件中的`window.$docsify`这么配置: ``` window.$docsify = { coverpage: ['/', '/zh-cn/'] }; ``` 或者具体指名文件名: ``` window.$docsify = { coverpage: { '/': 'cover.md', '/zh-cn/': 'cover.md' } }; ``` 7. 网站部署到 GitHub Pages --------------------- GitHub Pages 支持从三个地方读取文件: 1、`master`分支 2、`master`分支下的`docs`目录 3、`gh-pages`分支 1、如果你的文档直接是在项目根目录写的,那么可直接把代码推送到 master 分支上, `GitHub Pages`里选择`master branch`. 2. 如果你的文档是在 master 分支下的`docs/`目录下编写的,那么可直接把代码推送到 master 分支上,`GitHub Pages`里选择`master branch/docs folder`. 本例子项目是直接在根目录中编写的,所以`GitHub Pages`里选择`master branch`的方式部署。 首先在 github 网站上创建好仓库,然后终端打开项目目录: ``` git init git add . git commit -m 'docsify项目初始化' git remote add origin https://github.com/username/docsify.git git push --set-upstream origin master ``` 代码推送到 github 上后,打开 github 的仓库,选择`Settings` -> `GitHub Pages` -> `master branch` -> `save`。 ![](https://segmentfault.com/img/bVbmwTe?w=763&h=456) ![](https://segmentfault.com/img/bVbmwVq?w=1128&h=579) #### 7.1 使用 docsify 的例子 [https://spiritree.github.io/n...](https://spiritree.github.io/note/#/) [https://ripperhe.com/awesome-...](https://ripperhe.com/awesome-mac-html/#/) 8. 一些插件 ------- ### 8.1 搜索插件 全文搜索插件会根据当前页面上的超链接获取文档内容,在 localStorage 内建立文档索引。默认过期时间为一天,当然我们可以自己指定需要缓存的文件列表或者配置过期时间。 ``` <script> window.$docsify = { // 完整配置参数 search: { maxAge: 86400000, // 过期时间,单位毫秒,默认一天 paths: [], // or 'auto',匹配文件路径 placeholder: 'Type to search', // 搜索提示框文字, 支持本地化,例子在下面 // placeholder: { // '/zh-cn/': '搜索', // '/': 'Type to search' // }, noData: 'No Results!', // 找不到结果文字提示,支持本地化,例子在下面 // noData: { // '/zh-cn/': '找不到结果', // '/': 'No Results' // }, depth: 2, // 搜索标题的最大程级, 1 - 6 } } </script> <!-- 引入搜索模块 --> <script src="//unpkg.com/docsify/lib/plugins/search.js"></script> ``` ### 8.2 评论插件 Gitalk Gitalk:一个现代化的,基于 Preact 和 Github Issue 的评论系统。 使用例子: ``` <link rel="stylesheet" href="//unpkg.com/gitalk/dist/gitalk.css"> <script src="//unpkg.com/docsify/lib/plugins/gitalk.min.js"></script> <script src="//unpkg.com/gitalk/dist/gitalk.min.js"></script> <script> const gitalk = new Gitalk({ clientID: 'Github Application Client ID', clientSecret: 'Github Application Client Secret', repo: 'Github repo', owner: 'Github repo owner', admin: ['Github repo collaborators, only these guys can initialize github issues'], // facebook-like distraction free mode distractionFreeMode: false }) </script> ``` Gitalk 具体使用教程:[https://segmentfault.com/a/11...](https://segmentfault.com/a/1190000018072952) docsify 其他插件:[https://docsify.js.org/#/zh-c...](https://docsify.js.org/#/zh-cn/plugins) ### 8.3 样式插件 在网上找到一个样式:[https://jhildenbiddle.github....](https://jhildenbiddle.github.io/docsify-themeable/#/customization) 使用方法, 在 HTML 文件中引入: ``` <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css"> ``` 参考资料 ---- docsify 中文官网:[https://docsify.js.org/#/zh-cn/](https://docsify.js.org/#/zh-cn/)
Jonny
Sept. 16, 2021, 12:26 p.m.
946
0 条评论
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
如遇文档失效,可评论告知,便后续更新!
【腾讯云】2核2G云服务器新老同享 99元/年,续费同价
【阿里云】2核2G云服务器新老同享 99元/年,续费同价(不要✓自动续费)
【腾讯云】2核2G云服务器新老同享 99元/年,续费同价
【阿里云】2核2G云服务器新老同享 99元/年,续费同价(不要✓自动续费)
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期