使用docsify+github建立个人网站

写在前面的话

我之前根据网上的教程,用PythonDjango搭建博客,需要写代码,申请域名和服务器,对于我这种代码小白来说,真的很艰难。后来群里大神推荐了docsify这个神器,一切都变得那么轻松可爱~

安装docsify工具

docsify中文官网:https://docsify.js.org/#/zh-cn/quickstart

推荐安装 docsify-cli 工具,可以方便创建及本地预览文档网站。

npm i docsify-cli -g

在这之前,你要确保,你可以使用npm命令。如果你不能使用npm命令,你需要先安装Node.js。在Node.js官网下载最新的版本(太旧的版本,会不支持docsify,Windows又不能直接升级,就很麻烦)

下载之后,直接一路next下去,直至安装结束,过程很快。

然后重新打开命令提示符,输入npm i docsify-cli -g,这时候就没问题了。

部署github

在官网上,安装之后,就直接让大家初始化项目,生成doc文件了。但是我觉得,先部署github更方便。部署之后,直接在里面初始化项目。

打开github,右上角新建一个仓库。

仓库命名的时候,选一个好听的名字,因为你后面生成的主页,就是这个名字。最好用英文。选择Pulic属性,Private属性不能发布成网页。

仓库建好之后,在本地电脑上,选择一个你喜欢的地方,克隆这个库。
你可以在Clone or download中看到你应该克隆的网址。

克隆的时候,有两种类型,你可以选择HTTPS克隆,也可以选择SSH克隆。区别在于,HTTPS不需要输密码,SSH需要输密码(可以点击右上角进行切换)。因为是公开的库,所以其实任何人都可以下载,只是上传的时候,需要密码确认。

如果你选择HTTPS克隆,那直接输入你的http网址就可以直接克隆了,不需要密码。

git clone https://github.com/yangyang0126/blog.git

如果选择SSH克隆

git clone git@github.com:yangyang0126/blog.git

等待系统提示你输入密码,然后完成克隆

初始化项目

在命令提示符中,定位你刚刚克隆的文件夹位置。比如我定位到D盘的blog文件夹

D:\>cd blog

这时候,直接通过 init 初始化项目

docsify init ./docs

本地预览效果

在你创建docs文件后,系统会提示你,可以输入docsify serve ./docs,来预览效果

docsify serve ./docs

输入之后,你会看到,系统给了你一个网址http://localhost:3000

这时候,你就可以在浏览器输入这个网址,看看你现在的成果。

开始写文档

初始化成功后,可以看到 ./docs 目录下创建的几个文件

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

直接编辑 docs/README.md 就能更新网站内容。在你没有设置封面之前,首页的地址是:http://localhost:3000/#/README

个性化定制

具体关于侧边栏、封面等设置,大家都可以参考官网(中文版):https://docsify.js.org/#/zh-cn/quickstart。这里就提一下,官网里所有的代码,都是写在index.html 中的。

配套的.md文件,需要自己新建

附上部分插件的详细说明(有些插件,官网写的太简单了,没办法直接用)

上传github

在本地,你把docs下面的文档都写好了,那么我们就上传到GitHub上面去。

还是在blog这个文件下,右击Git Bash Here

检查文件夹状态

git status

添加所有修改的文件

git add .

给添加的文件注释,"***"里面写你觉得合适的注释

git commit -m "update 2020.02.20"

上传GitHub

git push origin master

这时候会让你输入密码的,你就输入(屏幕上并不会显示),然后回车

生成网站

进入GitHub,确认文件都传上去了。然后点击右上角的Settings

把页面一直往下翻,找到GitHub Pages,将source选为master branch/docs folder,这时候,你会在上面看到一个网址,我的是 https://yangyang0126.github.io/blog/

这个就是你做的网站了,是不是很神奇~

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

推荐阅读更多精彩内容