# docsify_sample **Repository Path**: boxtrade/docsify_sample ## Basic Information - **Project Name**: docsify_sample - **Description**: Docsify_Sample 提供各种样式的docsify样例文档,fork 即用;开盒即用! 本案例内容尽量缩减,作者只需要关心创作内容,替换格式即可。markdown文件即写成册。 - **Primary Language**: Unknown - **License**: MPL-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-01-30 - **Last Updated**: 2023-04-04 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # docsify_sample # 网站预览 [docsify_sample](https://boxtrade.github.io/docsify_sample/#/) > Docsify_Sample 提供各种样式的docsify样例文档,fork 即用;开盒即用! > > 本案例内容尽量缩减,作者只需要关心创作内容,替换格式即可。markdown文件即写成册。 # 须知 - 技术基础 git 基本命令,简单的前端基础 npm ;markdown 语法 - 改造点 [项目修改点 ](#项目修改点 ) - 静态部署 ## [GitHub Pages](https://docsify.js.org/#/zh-cn/deploy?id=github-pages) 使用,可在线编辑;类似于gitbook - 国内部署 ## [Gitee Pages](https://docsify.js.org/#/zh-cn/deploy?id=gitee-pages) - 离线查看 [本地预览](https://docsify.js.org/#/zh-cn/quickstart?id=%e6%9c%ac%e5%9c%b0%e9%a2%84%e8%a7%88) - 服务器部署 ## [VPS](https://docsify.js.org/#/zh-cn/deploy?id=vps) # 基础配置文件介绍 文件结构介绍 ``` 文件作用 文件 基础配置项(入口文件) index.html 封面配置文件 _coverpage.md 侧边栏配置文件 _sidebar.md 导航栏配置文件 _navbar.md 主页内容渲染文件 README.md 浏览器图标 favicon.ico ``` * [基础配置项 (入口文件)index.html ](index.html) * [1.1 封面配置文件 _coverpage.md](_coverpage.md) * [1.2 侧边栏配置文件 _sidebar.md ](_sidebar.md) * [1.3 导航栏配置文件 _navbar.md ](_navbar.md) * [1.4 主页内容渲染文件 README.md ](README.md) * [1.5 浏览器图标 ](favicon.ico) * ``` index.html 入口文件 README.md 会做为主页内容渲染 .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件 ``` # 项目修改点 1. 封面配置文件[封面配置文件](_coverpage.md) 文字介绍,图文链接修改 2. [1.2 侧边栏配置文件 _sidebar.md ](_sidebar.md) 目录及链接修改 3. [1.3 导航栏配置文件 _navbar.md ](_navbar.md) 链接修改 4. [基础配置项 (入口文件)index.html ](index.html) 仓库地址 repo: 替换成需要的地址 5. 修改 README.md 文件,开始写作 # 本地部署 [教程](https://docsify.js.org/#/zh-cn/quickstart) 通过运行 docsify serve 项目名称 启动一个本地服务器,可以方便地实时预览效果。默认访问地址 http://localhost:3000 。 # 重要文件 ?? 原因还在 todo .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件 # 存在问题 - 天下没有免费的午餐,好用的后台评论 几乎不存在! - gittalk 认证接口问题 不好用; - 页面加载缓慢 - 好多页面一下加载很多 md ,文件,用户体验差 - google 字体下载?? 默认不行吗 - 希望能越来越好 !!! # [关于捐赠](donate/README.md) [2.1 DONATE 捐赠](donate/README.md) - 捐赠的意义在于让原创更精彩! - 个人创作不易