php安装docsify,docsify - 无需构建快速生成文档网站

news/2024/5/10 0:54:51/文章来源:https://blog.csdn.net/weixin_29758513/article/details/116225646

bVGh1i?w=2562&h=1972

docsify

无需构建快速生成文档页

特性

无需构建,写完 markdown 直接发布

支持自定义主题

容易使用并且轻量

快速上手

创建项目

新建一个空项目,接着创建一个 docs 目录并进入到 docs 目录下

mkdir my-project && cd my-project

mkdir docs && cd docs

创建入口文件

创建一个 404.html 文件,内容为

新建 README.md 文件,作为主页面

# Title

## balabala

部署!

将项目 push 到 GitHub 仓库后到设置页面开启 GitHub Pages 功能,选择 docs/ 选项

1460000007656682?w=792&h=453

命令行工具

方便快速创建文档目录,会读取项目的 package.json 里的选项作为 docsify 的配置,支持本地预览。

安装

npm i docsify-cli -g

初始化文档

默认初始化在当前目录,推荐将文档放在 docs 目录下

docsify init docs

启动本地服务

docsify serve docs

主题

目前提供 vue.css 和 buble.css,直接修改 404.html 里的 cdn 地址即可

压缩版

更多功能

多页面

README.md 作为主页面,如果需要其他页面,直接在文档目录下创建对应的 *.md 文件,例如创建一个 guide.md 那么对应的路由就是 /guide。

导航

导航需要自己写在 404.html 文件里,效果参考本文档

En

中文

配置参数

repo

参考本文档的右上角的 GitHub 图标,如果要开启的话,将 404.html 里的 script 改成

max-level

目录最大展开层级,默认值为 6

el

替换节点元素,默认为 #app

sidebar-toggle

Sidebar 开关按钮

sidebar

设置后 TOC 功能将不可用,适合导航较多的文档,data-sidebar 传入全局变量名。

1460000007656683?w=297&h=174

window.sidebar = [

{ slug: '/', title: 'Home' },

{

slug: '/pageA',

title: 'page A',

children: [

{ slug: '/pageA/childrenB', title: 'children B' }

]

},

{ slug: '/PageC', title: 'Page C' }

]

load-sidebar

读取侧边栏配置文件,如果配置,默认加载当前目录下的 _sidebar.md。如果文件不存在,会显示 TOC 作为侧边栏内容。如果你有二级目录,也应该放置一份配置文件。

你可以指定侧边栏文件名

_sidebar.md 的内容可以是这样的

- [Home](/)

- [Installation](/installation)

- Essentials

- [Getting Started](/getting-started)

- [Dynamic Route Matching](/dynamic-matching)

- [Nested Routes](/nested-routes)

- [Programmatic Navigation](/navigation)

- [Named Routes](/named-routes)

- [Named Views](/named-views)

- [Redirect and Alias](/redirect-and-alias)

- [HTML5 History Mode](/history-mode)

load-navbar

读取导航配置文件,如果配置,默认加载当前目录下的 _navbar.md。如果文件不存在,会显示 html 里定义的导航栏。

你可以指定导航栏文件名

_navbar.md 的内容可以是这样

- [en](/)

- [中文](/zh-cn)

当然也支持二级列表,将生成一个下拉列表

- [download](/download)

- language

- [en](/)

- [中文](/zh-cn)

FAQ

为什么是 404.html 而不用 index.html

docsify 想要实现的是用最简单的方式 动态渲染内容。

例如我有两个文档分别为 README.md 和 guide.md,如果我用 index.html 作为文件名,README.md 可以被正确的渲染因为我们已经规定它为首页文件,但是如果我们访问 my-domain.com/guide 想要得到的结果是 guide.md 的内容,它将无法工作,因为目录下并不存在一个 guide.html 的文件。

但是 GitHub Pages 服务器找不到资源, 就会回退并渲染 404.html 文件。????

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.luyixian.cn/news_show_819676.aspx

如若内容造成侵权/违法违规/事实不符,请联系dt猫网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

哪里有模板建站配云服务器销售,模板建站配云服务器费用

模板建站配云服务器费用 内容精选换一换本节操作介绍华为云上云服务器的跨账号跨区域迁移,建议采用镜像迁移方式。服务器迁移的常见场景与常用的迁移方式请参考迁移的背景知识。跨账号跨区域迁移的方法请参考方案介绍常见的服务器迁移场景包括物理服务器与云服务器之…

【Python3 爬虫】06_robots.txt查看网站爬取限制情况

大多数网站都会定义robots.txt文件来限制爬虫爬去信息,我们在爬去网站之前可以使用robots.txt来查看的相关限制信息例如:我们以【CSDN博客】的限制信息为例子在浏览器输入:https://blog.csdn.net/robots.txt获取到信息如下:从上图…

海洋工作室——网站建设专家:FOXMAIL 自动收发设置

你的邮箱单击右键,选择“属性”,然后在弹出的对话框里选择“收邮件”,下面有个“每隔 自动收邮件”把它前面的勾选上,然后在里面填上你希望的时间间隔。 图片操作请参考下图:

SharePoint 2010新建站点不能登录解决方法

SharePoint 2010新建站点不能登录解决方法 近期在使用SharePoint 2010,今天我在一台新服务器上(单服务器,无域环境),新建了一个SharePoint 2010的站点(先创建Web应用程序,再创建网站集&#xff…

flash 多张相片同时移动_如何从SEO优化的角度来打造一个移动网站

移动互联网的发展已经影响了人们生活的很多关键领域,在最近的这两年内,资讯类网站的形式已经到了一个“临界点”,读者了解获取新闻消息几乎都是通过手机或平板电脑,其内容生产方式也发展成为响应式设计网站,那么&#…

虚拟主机怎么做云服务器,云虚拟主机怎么安装网站程序?

云虚拟主机怎么安装网站?虚拟主机安装网站怎么操作呢,首选需要给虚拟主机绑定域名,接着到域名管理处解析处添加解析记录,此后给虚拟主机安装网站系统,这样的话就安装好一个网站。一般的云虚拟主机可以安装哪些网站?虚拟主机可以…

图片大_36个精美的大背景图片网站设计

大型背景网站设计已成为Web开发领域中的热门话题。使用大图像作为背景会对用户产生影响;它吸引了他们,并促使他们进一步探索。这种设计技术被证明是最小的,但却可以确保一次又一次的极好的用户体验。以下是精美执行的大型图片网站设计的20个示…

element做树形下拉_做SEO有何技巧?

做SEO有何技巧?SEO(Search Engine )汉译为搜索引擎优化。搜索引擎优化是一种利用搜索引擎的搜索规则来提高目前网站在有关搜索引擎内的自然排名的方式。SEO的目的理解是:为网站提供生态式的自我营销解决方案,让网站在行…

lisp标注界址点号_白杨SEO:企业商家怎么做百度地图标注、优化排名、推广引流和营销?【实操方法】...

前言:这是白杨SEO公众号原创第169篇。之前SEO好友王海写了一篇高地图标注方法(文尾),所以今天我来写一篇百度地图标注实操的。大纲如下:1、百度地图是什么,有什么意义?2、企业商家百度地图位置怎…

如何把网站迁移到云服务器上,网站迁移到云服务器需要注意哪些

原标题:网站迁移到云服务器需要注意哪些网站迁移到云服务器的注意事项有哪些?企业在将现有系统、网站或应用迁移到云服务器的过程中,经常遇到诸多故障,例如数据库错误,数据丢失,应用程序和网站崩溃等。这些…

php小说网站windows慢,同样的网站,为啥你的网站打开这么慢?

当我们需要选择服务器的时候,windows和linux应该如何选择呢?windows给了我们一个可视化的系统,就想在本机物理电脑一样,配置这些都是非常简单的;但是对于现在的PHP程序而言,选择windows的服务器其实是不太明…

aspxspy mysql_网站管理软件 - AspxSpy2014 Final

受bin牛委托修改并发布,版权归bin牛所有。Bug/建议提交:zcgonvhrootkit.net.cn祝各位马年大吉,财源滚滚。免责声明:本程序只用于管理员安全检测,使用前请注意环境与法律法规,因使用不当造成的后果本人不承担…

网站的服务器什么意思,网站服务器站点是什么意思

网站服务器站点是什么意思 内容精选换一换本文目录什么是WSGI?如何实现Application?如何实现Web Server?Web Server如何决择?. 什么是WSGI?WSGI(Web Server Gateway Interface),顾名思义,它既不是服务器,…

JS网站

2019独角兽企业重金招聘Python工程师标准>>> http://jsrun.net/ js动画 http://visionmedia.github.io/move.js/ Move.JS JS动画 http://www.superslide2.com/TouchSlide/ 触屏滑动 http://passer-by.com/project.html 日常 http://bouncejs.com/ …

网站使用自定义字体导致打开很慢

今天偶尔看到一个网页打开首页一分钟竟然还没有出来!!! 这还了得,做IT就是强迫症多,非得看看是什么原因,不用说F12跑一圈!! 查找原因,是ttf字体库导致的,一…

域名、ip、以及通过域名访问网站、虚拟主机

ip 是一个网站的id,是它的地址。 域名是为了解决ip比较难记住才引出的。 利用nginx来配置虚拟主机,通过域名可以访问该网站。 具体实现详见前面文章。 虚拟主机:可以实现在一台服务器虚拟出多个网站。例如个人网站使用的虚拟主机。节省成本。…

怎样说网站服务器性能不足,服务器性能不足 怎样才能逼出最强状态

1提性能不提价,这事也不难服务器的性能对于每个企业来讲都是十分重要的一环,一款性能强大性价比高的服务器能够为企业的竞争力增加更多筹码。那么当服务器性能不足时,如何才能让其达到最强状态呢?先定一个小目标双核才能更稳定提高…

线粒体和叶绿体的基因组特点_叶绿体/线粒体在线注释网站GeSeq使用简介

叶绿体/线粒体在线注释网站GeSeq 上篇介绍了一个线粒体在线注释网站,MITOS,今天呢白鱼小编继续给大家推荐另一个在线注释网站,GeSeq。该网站即可用于注释线粒体,也可用于叶绿体。GeSeq主要以同源注释的方式,快速准确地实现细胞器基因组的注释,特别是叶绿体基因组。 GeSeq…

SEO独家揭秘:搜索引擎如何识别链接作弊!

国内的搜索引擎在关于“外链”的文章里面,绝大多数会强调外链的价值,很少去强调链接背后的反作用,也就是今天要给大家深度解读的链接作弊。笔者在SEO领域从业多年,但是在搜索引擎链接分析这块,见证过各种链接对于排名的…

连接网络或PHP文件失败,phpcms v9主页栏目连接失败怎么办 PHPCMS网站建站教程

phpcms v9主页栏目连接失败怎么办?phpcms V9 网站域名变更后,刷新所有缓存后,栏目链接总是改不过?网站在发展的过程中,很可能多次的修改域名。那么在PHPCMS V9中我们要怎么进行设置呢?请进行以下步骤的修改…