1 Star 0 Fork 0

CLOT-LIU/Docsify

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

🎊 Docsify 模板,下载即用

1. Docsify 安装及初始化

  • 全局安装 docsify-cli 工具,可以方便地创建及在本地预览生成的文档。

    npm i docsify-cli -g
  • 新建文件夹(名字、位置随意),进入到文件夹,并初始化

    # 我的文件在e盘下docs
    e:			# 进入到e:
    cd docs			# 进入到文件夹
    docsify init		# 初始化
  • 初始化成功后,可以看到 ./docs 目录下创建的几个文件

    • index.html 入口文件
    • README.md 会做为主页内容渲染
    • .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件

2. Docsify 服务启动

  • 通过运行 docsify serve 启动一个本地服务器,可以方便地实时预览效果。默认访问地址 http://localhost:3000

    docsify serve

3. 克隆

  • 克隆仓库或者下载仓库文件
  • doc 内的文件替换 ./docs 目录下的文件(刚刚创建的文件夹)
  • 启动 Docsify 服务,访问 http://localhost:3000 即可看到
  • index.html 就是配置文件

4. 推荐一下我写的文章 😋

MIT License Copyright (c) 2021 Mr.XiaoSi Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

Docsify 笔记模板 展开 收起
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/clot-LIU/Docsify.git
git@gitee.com:clot-LIU/Docsify.git
clot-LIU
Docsify
Docsify
master

搜索帮助

A270a887 8829481 3d7a4017 8829481