docsify-写一个自己的网站

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,590评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,808评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,151评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,779评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,773评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,656评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,022评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,678评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,038评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,756评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,411评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,005评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,973评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,053评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,495评论 2 343

推荐阅读更多精彩内容

  • 第一章 安装Git工具 下载GitHub for Windows,直接点击安装,安装完成后,可以看到“Git Sh...
    不圆的石头阅读 11,844评论 5 63
  • 前几日画了个人脸,对素描又有了兴趣。今天专门画了个眼睛。看看如何? 睫毛,瞳孔,眼睑几个特征要画好,能体现出眼睛的...
    bigboss妈咪阅读 416评论 3 3
  • 今天又搬家,累的筋疲力尽,好在有同事的热心帮忙,大热的天,真是辛苦你们了,你们的好我都记下了,厂里的每个人都那么和...
    冰咋吃阅读 191评论 0 1
  • 你说,我不敢见你, 我说,我不敢见你。 早上睁开眼的刹那, 就在寻你。 晚上睡前的最后一句话, 需留给你, 直到不...
    爱那么多阅读 127评论 0 0
  • 傍晚的湖滨,游人络绎不绝。晚风袭来,惬意怡人。晚上七点半,湖滨音乐喷泉开始播放。音乐响起,喷泉喷出水花,舞动的水花...
    氧气姑娘666阅读 231评论 0 0