# docsify-test

**Repository Path**: netbuffer/docsify-test

## Basic Information

- **Project Name**: docsify-test
- **Description**: 基于docsify实现静态网站生成器，文档内容基于markdown格式
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: http://netbuffer.gitee.io/docsify-test
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-11-25
- **Last Updated**: 2026-09-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JavaScript, API, Markdown, Documentation

## README

# 📚 docsify-test

![docsify](https://img.shields.io/static/v1?label=docsify&message=v5.0.0&color=42b983)
![node](https://img.shields.io/static/v1?label=node&message=v24.21.0-lts-alpine&color=black)
![license](https://img.shields.io/static/v1?label=license&message=demo&color=lightgrey)

> 🚀 基于 [Docsify](https://docsify.js.org) **v5.0.0** 的静态文档站点演示工程。Markdown 即网站，**无需构建**。

本仓库已从早期 **v4** 升级到当前 npm `latest` 稳定版（2026-07 发布），CDN 钉死 `@5.0.0`。升级说明见 [FAQ](docs/faq.md)。

## ✨ 本仓库演示了什么？

本地用浏览器完整点验过（`docsify serve docs`），下列能力均可正常使用：

| 能力 | 说明 | 状态 |
|------|------|------|
| 🖼️ 封面页 | `_coverpage.md` | ✅ |
| 📑 多级侧栏 | `_sidebar.md` + `subMaxLevel` | ✅ |
| 🧭 顶部导航 | `_navbar.md` | ✅ |
| 🔍 全文搜索 | 官方 search 插件 | ✅ |
| 😀 Emoji 短码 | `:smile:` → 图片表情 | ✅ |
| 📋 代码复制 | docsify-copy-code | ✅ |
| 📄 章节分页 | docsify-pagination | ✅ |
| 🔎 图片缩放 | zoom（原 zoom-image） | ✅ |
| 🌈 语法高亮 | Prism（bash / js / json / yaml / md） | ✅ |
| 😵 自定义 404 | `_404.md` | ✅ |
| 🧩 自定义 Hook | 页脚「在 GitHub 编辑」 | ✅ |

更细的说明与自测清单见站点内 [🧪 能力总览](docs/features.md)。

## 🌐 Demo

* 🐙 [GitHub Pages](https://netbuffer.github.io/docsify-test)
* 🦢 [Gitee Pages](https://netbuffer.gitee.io/docsify-test)

## 🚀 快速开始

### 方式一：Docker Compose（推荐，无需本地安装 Node）

```bash
# 启动容器服务
docker compose up -d

# 停止容器服务
docker compose down
```

### 方式二：本地 Node 运行

```bash
# 安装 CLI（若 postinstall 报错可加 --ignore-scripts）
npm i docsify-cli -g --ignore-scripts

# 预览 docs 目录
docsify serve docs

# 指定端口
docsify serve docs -p 3000
```

浏览器打开终端提示的地址（默认 `http://localhost:3000`）。

> 💡 不要用 `file://` 直接打开；Docsify 需要通过 HTTP 静态服务加载 `.md`。

## 📂 目录结构

```text
docsify-test/
├── README.md                 # 本文件
└── docs/                     # 站点根（可直接挂 GitHub /docs）
    ├── .nojekyll             # GitHub Pages 保留下划线文件
    ├── index.html            # Docsify v5 入口与插件配置
    ├── _coverpage.md         # 封面
    ├── _navbar.md            # 顶栏
    ├── _sidebar.md           # 侧栏
    ├── _404.md               # 404
    ├── _media/icon.svg       # 封面 Logo
    ├── README.md             # 首页
    ├── features.md           # 能力总览
    ├── markdown.md           # Markdown 演示
    ├── plugins.md            # 插件说明
    ├── config.md             # 配置说明
    ├── faq.md                # FAQ
    └── test.md               # 联调页
```

## 🧪 建议自测步骤

1. 打开封面 → 点「开始阅读」进入正文  
2. 顶栏 / 侧栏跳转各页面  
3. 搜索框输入「封面」「插件」看命中  
4. 代码块点「📋 复制」  
5. 页底「上一章 / 下一章」翻页  
6. 访问 `#/not-exist` 看 404  
7. Markdown 页确认 `:smile:` 等短码已渲染  

## 🔗 相关链接

* 📘 [Docsify 快速开始](https://docsify.js.org/#/quickstart)
* 🐙 [docsifyjs/docsify](https://github.com/docsifyjs/docsify)
* 🧰 [docsify-cli](https://github.com/docsifyjs/docsify-cli)
* 🌟 [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
* 本仓库：[GitHub](https://github.com/netbuffer/docsify-test) · [Gitee](https://gitee.com/netbuffer/docsify-test)

## 💡 小贴士

URL 使用 Hash 路由：`#/features`、`#/markdown`、`#/test` 对应 `docs/` 下同名 Markdown。

---

Made with ❤️ and Docsify