docsify-写一个自己的网站

https://www.jianshu.com/p/88e70f32b049

docsify

安装

安装node，然后建议全局安装docsify-cli，有助于在本地初始化和预览网站。

npm i docsify-cli -g

如果需要部署到gitHub，则也安装一下git。

初始化

使用init命令初始化。如果要在./docs子目录中编写文档，则可使用下面命令：

docsify init ./docs

001.png

002.png

上面是执行命令过程与自动生成的文件的截图，下面简单介绍下docs中的3个文件：

.nojekyll：让gitHub不忽略掉以 _ 打头的文件
index.html：整个网站的核心文件
README.md：默认页面

这里最好只采用docs目录，官方推荐，而且将文档放到gitHub上时，也必须是docs。

本地预览文档

进入docs目录，运行本地服务器 docsify serve，然后在浏览器中打开 http://localhost:3000即可。

// 如果要预览的文档在docs中，则使用 docsify serve 即可。
docsify serve

005.png

也可以不进入docs目录运行本地服务器：docsify serve docs。

gitHub上预览文档

应该都知道 gitHub 是放置代码的网址，其实它还有一个强大的预览文档的功能。如果将 docsify文档放置到 gitHub 上，可以通过gitHub直接预览。

在gitHub 建个仓库。本文档的仓库名是 extraordinarywen。
在本地获取仓库：git clone https://github.com/taoGod/extraordinarywen.git (仓库地址)
进入本地仓库，初始化docsify：docsify init ./docs
提交文档并防止到gitHub：

git add .
git commit -m 'msg'
git push orgin master // 这个之前需要提供 gitHub 账号和密码

在此上gitHub看一下该仓库是否有预想的效果了。
呵呵，显然还不够，不过只差最后一步了。点击setting，找到 GitHub Pages，配置分支为 master barnch /docs folder，点击保存。然后会自动发布，并且给出发布的网站地址。

003.png

004.png

点击上图中url：Your site is published at url。意不意外，惊不惊喜呢？反正我第一次我是挺惊喜
以后你只需要写东西放到该仓库，网站自动会更新。

再次推荐：docsify。

docsify-写一个自己的网站相关推荐

用Java手写一个微型下载资源网站
文章目录手写一个微型下载资源网站[Java实现用户注册.登陆.下载功能] 一.技术栈二.流程分析图注册登陆下载三.案例实现效果首页注册登陆下载网主页壁纸下载书籍下载影视下载 ...
docsify写一个自己的文档网站
1. docsify介绍 docsify 是一个动态生成文档网站的工具.支持 markdown 语法能直接部署在 GitHub Pages. 可以用来当做项目的说明文档,也还可以当做自己专属的知识小仓 ...
如何写一个优质的网站标题title？
网站标题也就是我们俗说的网站title,在html的超文本标签中<title>对于网站的设计和seo搜索引擎的优化都是有着重大的意义,网站的标题决定着我们网站的流量和转化的多少,一个好的标 ...
学习写一个模仿天猫网站
学习完了前端的HTML CSS JavaScript等各项技术之后,会有一个感慨,各个知识点分开都不难,但是要做出一个成型的,好看的,时尚的网页,就无从下手. 这就需要经验的积累了. 那么,写一个模仿 ...
用PHP和HTML写一个简单的网站登录注册项目
首先,这是一个很简单的登陆注册页面,请不要在意美观及设计,重点在于登录注册这个功能.这个项目由五个分页组成: 1.index.php :一个简单的首页,有login register,当用户登录之后 ...
用C#WebClient+Server酱写一个监听网站通知的功能
Server酱:https://sc.ftqq.com/3.version 功能:往 http://sc.ftqq.com/SCKEY.send 发GET请求,就可以在微信里收到消息. using S ...
如何用C++写一个网站
1.前言用各种语言写过一些网站之后,我不禁开始好奇,C++能不能写网站呢,实际上想到这个问题的时候,我就大致有了答案. 本文中我们将尝试用C++写一个简单的网站,探索一些细节性的问题,并报告用C++ ...
利用爬虫写一个智能垃圾桶
利用python爬虫写一个智能垃圾分类网站怎么查获取需要的值修改地址问题感谢网站其实垃圾分类网上很多了,利用各种方法的API(有付费的也有免费的)但是我最近看到一个网站https:// ...
模仿写一个小型网站框架
之前的博文中讲述MVC的时候,介绍了美女同学的简单框架one.本来就打算要在美女框架的基础上有所改进,至少能够独立搭出一个成型的小网站出来(有界面交互,有db读写等).刚好最近工作内容不同,故借此机会 ...
多年前写的一个ASP.NET网站管理系统，到现在有些公司在用
多年前写的一个ASP.NET网站管理系统,到现在有些公司在用今早上接到一个电话,自已多年前写的一个ASP.NET网站管理系统,一个公司在用,出了点问题, 第一点是惊奇,5,6年前的东东,手机号码换了 ...

docsify-写一个自己的网站

安装

初始化

本地预览文档

gitHub上预览文档

更多

docsify-写一个自己的网站相关推荐

最新文章

热门文章