【docsify】为网站写一个说明文档

news/2024/5/20 10:47:45/文章来源:https://blog.csdn.net/Zhiend/article/details/123712102

【docsify】为网站写一个说明文档

!官方部署文档

全局安装

npm i docsify-cli -g

全局安装

初始化项目

在项目文件夹下,初始化

docsify init ./docs

在这里插入图片描述
会生成三个文件
在这里插入图片描述

./docs 下

  • index.html作为入口文件
  • README.md作为主页
  • .nojekyll防止 GitHub Pages 忽略以下划线开头的文件

可以轻松地更新文档中的内容./docs/README.md
也可以添加更多页面

入口(封面)

打开index.html
在这里插入图片描述

	name: '', //名称repo: ''   //git地址

添加一行,开启渲染封面的功能

 	coverpage: true

完成编写后保存

本地预览

docsify serve ./docs

在这里插入图片描述
在 http://localhost:3000/#/ 下预览
在这里插入图片描述

封面

新建文档_coverpage.md
为封面写入简略说明,保存
在这里插入图片描述
还可修改

<!-- 背景图片 -->![](_media/bg.png)<!-- 背景色 -->![color](#f0f0f0)

且主题(index中的css样式)也有多种选择

  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css"><link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css"><link rel="stylesheet" href="//unpkg.com/docsify/themes/dark.css"><link rel="stylesheet" href="//unpkg.com/docsify/themes/pure.css"><link rel="stylesheet" href="//unpkg.com/docsify/themes/dolphin.css">

URL生成二维码

生成二维码

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

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

相关文章

Java开源建站工具

2011-08-12 09:22 | 4162次阅读 | 【已有12 条评论】发表评论 来源&#xff1a;阮一峰的网络日志 | 收藏到我的网摘 美国程序员Jon Scott Stevens&#xff0c;公布了他的创业公司所使用的开发工具清单 。 他的语言平台是Java&#xff0c;开发项目是一个网站&#xff08;还…

转:有了这些网站,英文论文再也不难写了(15个英文论文写作辅助网站介绍和使用技巧)

大家在写英文论文的时候&#xff0c;都会遇到这样一些情况&#xff1a;句子写不出来想找一个例句参考&#xff0c;想搜索一下单词的搭配和习惯用法、想核对自己写的句子是否正确等等。 下面给大家介绍的网站主要在写英文论文的时候&#xff0c;可以提供例句参考、单词搭配和用…

IIS - 自动申请、部署Let’s Encrypt的免费SSL证书(让网站实现HTTPS协议)

IIS - 自动申请、部署Let’s Encrypt的免费SSL证书&#xff08;让网站实现HTTPS协议&#xff09; 一、HTTPS 协议介绍 1&#xff0c;什么是 HTTPS 协议&#xff1f; HTTPS&#xff08;全称&#xff1a;Hyper Text Transfer Protocol over Secure Socket Layer&#xff09;&am…

React+flask 搭建网站---React 环境搭建

系统环境: mac 搭建过程: 1、安装node.js : 安装任何包时一定要取官网查看安装方法(因网络中每个人安装的环境和版本有差异,尽量安装官网指导进行安装).官网地址:https://nodejs.org/zh-cn/ 现在后,进行安装.安装完成后,进行后续操作. 2、安装React 创建应用的工具(脚…

小白学习React+flask 搭建网站-Flask 环境搭建

电脑系统: mac 安装过程如下: 1、新建文件夹用来存储需要创建的应用:(参照官网地址:http://flask.pocoo.org/docs/1.0/installation/) mkdir backend01 (backed01 是我创建的文件夹名称,这个名称可以自行定义).安装环境创建包:virtualenv virtualenv venv 2、创建环境:进…

网站开发工具、技术

前端开发 require.js 首先&#xff0c;加载的时候&#xff0c;浏览器会停止网页渲染&#xff0c;加载文件越多&#xff0c;网页失去响应的时间就会越长&#xff1b;其次&#xff0c;由于js文件之间存在依赖关系&#xff0c;因此必须严格保证加载顺序&#xff08;比如上例的1.…

网站首页抓取和收录情况分析(个人见解)

求职类网站的实效性比较重要&#xff0c;提供最新的职位信息&#xff0c;对网站和求职者都有帮助。我们网站的PR值还可以&#xff0c;但是采用的是静态首页&#xff0c;也就是更新的内容不会体现在首页上&#xff0c;那么搜索引擎对首页的蜘蛛爬行和更新都会比较慢。 下面是我们…

php+redis+python网站部署方案

1 采用原web总数据库&#xff0c;后端直接采用php。 2 采用原web总数据库&#xff0c;后端采用python/phpredis数据优化方案。 3 采用新的数据库&#xff0c;即将原有数据库拷贝&#xff0c;后端采用python/phpredis数据优化方案。 采用redis数据库可以大幅度提高查询性能。 部…

利用Python进行电商网站用户行为分析

电商网站用户行为分析 项目需求 1.用户整体购物情况怎样&#xff1f; 统计数据集中总的用户数&#xff0c;商品数&#xff0c;商品类别数&#xff0c;用户行为数。核心指标如PV&#xff0c;UV&#xff0c;跳出率&#xff0c;复购率&#xff0c;留存率等分别是多少? 2.用户…

win7 IIS7 发布网站 出现 处理程序“PageHandlerFactory-Integrated”在其模块列表中有一个错误

windows7下发布web项目需要安装IIS,当安装完以后,web程序已经映射到了本地IIS上,运行出现如下错误提示 处理程序“PageHandlerFactory-Integrated”在其模块列表中有一个错误模块“ManagedPipelineHandler” 原因: vs2010默认的是4.0框架&#xff0c;4.0的框架是独立的CLR&…

UI应遵循的三大网站设计原则

触摸优先设计、响应式设计、移动优先设计是UI设计师设计网站应遵循的三大原则&#xff0c;以使网站最大范围地适应各种设备。外文《Designing The Well-Tempered Web》中详细阐述了这三大原则。CSDN对该文进行了编译&#xff0c;内容如下&#xff1a; 随着技术的进化&#xff…

如何构建高扩展性网站?

阅读目录 主要内容化简方程分布工作横向扩展设计使用正确的工具不要做重复的工作积极利用缓存从错误中吸取教训数据库原则容错设计与故障控制避免或分发状态异步通信和消息总线其他原则参考 本篇通过阅读《高扩展性网站的50条原则》&#xff0c;总结出以下内容。 一方面博主没有…

利用压缩网页来提升网站浏览速度

转至 &#xff1a;http://blog.csdn.net/joliny/article/details/2124344 在线查询&#xff1a;http://tool.chinaz.com/Gzips 本文主要介绍如何通过对页面进行压缩从而节省网站的带宽以及提升用户的访问速度。 网站的访问速度是由多个因素所共同决定的&#xff0c;这些因素例…

机器学习:K-近邻算法(二)约会网站配对效果

目录 K-近邻算法实战(二)&#xff1a;约会网站配对效果判断 实战 1.背景介绍 2.准备数据&#xff1a;数据分类 3.分析数据&#xff1a;数据可视化 4.准备数据&#xff1a;数据归一化 5.测试算法&#xff1a;验证分类器 6.使用算法&#xff1a;构建完整可用系统 K-近邻算法实…

前端布局,最如何合理布局最底下的公司和网站信息

如何让公司和网站信息始终布局在页面的最下方&#xff0c;之前试过多种方式&#xff0c;特别是用固定定位的方法&#xff0c;很难达到满意的效果。 后来多次尝试后得出&#xff0c;这块还是有窍门 首先父盒子要设置相对定位&#xff0c;并且设置页面的高度&#xff08;也就是说…

VS.NET2013发布网站的时候去掉.cs文件(预编译)

原帖地址&#xff1a;http://blog.sina.com.cn/s/blog_6f72ff900102vcbp.html VS2013在WIN8下扁平的UI和我今天锈垢的大脑&#xff0c;让找这个设置找了好半天&#xff01;&#xff01;&#xff01; OK&#xff0c;言归正传。 在要发布的网站上右键&#xff0c;选择"发布…

一步步构建大型网站架构

之前我简单向大家介绍了各个知名大型网站的架构&#xff0c;MySpace的五个里程碑、Flickr的架构、YouTube的架构、PlentyOfFish的架构、WikiPedia的架构。这几个都很典型&#xff0c;我们可以从中获取很多有关网站架构方面的知识&#xff0c;看了之后你会发现你原来的想法很可能…

复制文字需要登录的网站如何跳过登录

复制文字需要登录的网站如何跳过登录 网页复制类型js代码使用说明 网页复制类型 文章展示的网页&#xff0c;根据可复制性&#xff0c;我将其分成三类&#xff1a; 文字可复制&#xff1a;没有任何文字复制的限制文字可复制但需要登录&#xff1a;选中文字后复制时&#xff0…

正在找工作的设计师,你应该把自己的作品集放在云端--读完此文轻松搞定个人作品网站

AWO起源 很多公司的内推系统对设计师非常不友好&#xff0c;甚至可以说“歧视设计职位”&#xff0c;有的要求作品必须是pdf&#xff0c;有的要求体积限制在12m以内&#xff0c;反正花样繁多。一个优秀的设计作品要阐述清晰设计理念和观点&#xff0c;往往需要一个2000px以上的…