mdView 文档
欢迎使用 mdView 文档系统
👁9 次阅读·📖约 4 分钟

使用教程

本文档详细介绍如何使用 mdView 文档系统。

开始使用

访问系统

  • 打开浏览器，输入部署地址
  • 系统会显示文档首页（默认跳转到 intro.md）
  • 侧边栏显示文档目录结构

    • 浏览文档

  • 点击文档名称：在侧边栏点击文档名称即可打开查看
  • 展开目录：点击带有箭头的目录可以展开查看子文档
  • 面包屑导航：文章顶部显示完整的路径导航

    • 切换主题

  • 点击主题按钮：页面顶部有主题切换按钮
  • 选择主题：
  • ☀️ 亮色主题：适合白天使用
  • 🌙 暗黑主题：适合夜间使用

    • 调节字体

  • 点击字号按钮：页面顶部有字号调节按钮
  • 选择字号：提供四级字号调节

    • Markdown 语法指南

    标题

    # 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

    粗体和斜体

    **粗体文本**
*斜体文本*
***粗斜体文本***

    列表

    - 无序列表项 1
- 无序列表项 2
  - 嵌套列表项

1. 有序列表项 1
2. 有序列表项 2

    链接和图片

    [链接文本](https://example.com)
![图片描述](https://example.com/image.jpg)

    代码

    `单行代码`

```php
function hello() {
    echo "Hello World";
}

    
### 表格

```markdown
| 列1 | 列2 | 列3 |
|------|------|------|
| 内容1 | 内容2 | 内容3 |

    引用

    > 这是引用文本
> 可以有多行

    Frontmatter（文档元数据）

    在文档顶部可添加 YAML 元数据：

    ---
title: 文档标题
description: 文档描述（用于 SEO）
keywords: 关键词1,关键词2
---

# 正文标题

正文内容...

    后台管理

    登录后台

  • 在浏览器中访问 /admin
  • 输入用户名和密码
  • 点击「登录」按钮

    • 控制台

    后台首页显示系统概览信息，包括文档总数、用户数等统计数据。

    文档管理

    同步文档

  • 点击左侧菜单的「文档管理」
  • 点击「同步文件系统」按钮
  • 系统会扫描 docs/ 目录并更新文档树

    • 编辑文档

  • 在文档列表中点击文档进入编辑页
  • 使用编辑器修改 Markdown 内容
  • 点击保存

    • 文档排序

    在文档管理页面可拖拽调整文档和文件夹的显示顺序。

    用户管理

  • 点击左侧菜单「用户管理」
  • 可创建、编辑、删除用户
  • 为用户分配角色

    • 角色管理

  • 点击左侧菜单「角色管理」
  • 创建角色并配置权限
  • 系统内置角色：超级管理员、编辑、高级会员、普通会员、查看者、访客

    • 菜单管理

  • 点击「菜单管理」管理顶部导航栏菜单
  • 点击「Footer 菜单」管理底部链接

    • 广告管理

  • 创建广告分类和广告位
  • 添加广告项（支持图片和 HTML）
  • 广告位包括：顶部横幅、侧边栏、内容区、底部等

    • 阅读配额

  • 点击「阅读配额」设置各角色的阅读限制
  • 配置每日/每周/每月阅读上限
  • 设置超出配额后的升级引导角色

    • 文档分享

  • 在文档管理中可生成分享链接
  • 分享链接 /s/{token} 可绕过登录直接访问文档
  • 支持设置过期时间和阅读次数限制

    • 推荐文档

    在「推荐文档」中可将文档标记为推荐，在页面底部显示推荐文章列表。

    点击统计

    查看各文档的阅读量统计，支持重置计数。

    静态化部署

  • 点击「静态化部署」
  • 配置 Base URL 和输出目录
  • 点击「开始构建」生成纯静态 HTML 站点
  • 将 static/ 目录部署到 Nginx 或其他 Web 服务器

    • 系统设置

  • 点击左侧菜单「系统设置」
  • 修改网站名称、描述等全局参数
  • 点击「保存设置」按钮

    • 高级功能

    TOC 目录导航

  • 查看目录：文档右侧会显示自动生成的目录
  • 点击跳转：点击目录项可以快速跳转到对应位置
  • 层级显示：目录会按照标题层级显示

    • 文档搜索

  • 快捷键：Ctrl + K 或按 / 键打开搜索
  • 关键词高亮：搜索结果中匹配的关键词会高亮显示
  • 内容片段：显示包含关键词的上下文内容片段
  • 键盘导航：使用 ↑↓ 键选择，Enter 跳转

    • 移动端支持

  • 响应式布局：页面会自动适应不同屏幕尺寸
  • 侧边栏菜单：点击左上角按钮打开/关闭侧边栏
  • 触摸友好：所有按钮和链接都支持触摸操作

    • 最佳实践

    文档组织

  • 使用目录结构：按照功能模块组织文档
  • 统一文件名：使用有意义的文件名，支持中文路径
  • 保持层级清晰：不超过三级目录

    • 内容编写

  • 使用 Markdown：统一使用 Markdown 格式编写
  • 添加 Frontmatter：为重要文档添加 title、description、keywords
  • 保持简洁：每个文档专注于一个主题
  • 添加示例：代码示例有助于理解
  • 使用图片：适当使用图片说明复杂概念

    • 权限管理

  • 最小权限原则：只给用户分配必要的权限
  • 定期审查：定期检查用户权限配置
  • 及时禁用：离职员工及时禁用账户

    • 性能优化

  • 启用静态化：将文档编译为静态 HTML 以获得最佳性能
  • 压缩图片：优化文档中图片的大小
  • 合理使用广告：避免过多广告影响阅读体验

    • 更多帮助信息，请查看其他帮助文档或联系系统管理员。

    ❓ 遇到问题？查看常见问题解答与使用教程
    mdView 文档系统开源技术文档

    🔥 热点文章