快速开始
本文档将帮助您快速了解如何部署和使用 mdView 文档系统。
环境要求
注意：系统默认使用 SQLite，PHP 的 pdo_sqlite 扩展通常已内置。
如需使用 MySQL 或 SQL Server，请创建 config.php 并安装对应的 PDO 扩展。
可通过 php -m | grep pdo_ 检查已安装的 PDO 驱动。
部署方式
方式一：PHP 内置服务器（开发测试）
# 进入项目目录
cd mdView
# 启动 PHP 内置服务器
php -S localhost:8080
# 浏览器访问 http://localhost:8080
方式二：Apache 部署
htdocs 目录（或配置虚拟主机）mod_rewrite 模块已启用.htaccess 文件生效（AllowOverride All）方式三：Nginx 部署
server {
listen 80;
server_name your-domain.com;
root /path/to/mdView;
index index.php;
location / {
try_files $uri $uri/ /index.php?$args;
}
location ~ \.php$ {
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
include fastcgi_params;
}
}
首次访问
data/mdview.db）界面导览
系统采用 VitePress 风格的三栏布局：
添加新文档
方法一：手动添加（推荐）
docs/ 目录下创建新的 .md 文件（支持子目录，如 docs/开发/my-doc.md）/admin）方法二：后台创建
登录后台管理，在「文档管理」中直接创建文档节点并编写内容。
默认账户
系统首次运行时会自动创建管理员账户：
其他角色（如编辑、查看者）需要在后台「角色管理」中手动创建后，再到「用户管理」中添加对应账户。
Markdown 写作
系统使用 Vditor 编辑器，支持以下 Markdown 特性：
基础语法
# 到 ######（六级标题）粗体、斜体文本
` code ` 和围栏代码块（支持语法高亮）> 引用文本---扩展特性
- [x] 已完成、- [ ] 未完成[^1]Frontmatter（元数据）
在 Markdown 文件顶部使用 YAML Frontmatter 设置文档元数据：
---
title: 自定义标题
description: 文档描述（用于 SEO）
keywords: 关键词1,关键词2
---
配置说明
数据库配置
系统默认使用 SQLite 数据库，零配置开箱即用。数据文件位于 data/mdview.db。
如需切换到 MySQL 或 SQL Server，创建项目根目录下的 config.php：
return [
'db' => [
'type' => 'mysql', // 改为 mysql 或 sqlserver
'mysql' => [
'host' => '127.0.0.1',
'port' => 3306,
'database' => 'mdview',
'username' => 'root',
'password' => '',
'charset' => 'utf8mb4',
],
],
];
详细配置说明参见 数据库系统文档。
数据存储
系统首次运行时会自动创建。使用其他数据库时，数据存储在对应的数据库服务器上。
自定义配置
登录后台管理（/admin），在「系统设置」中可以配置：