docsify-寫一個自己的網(wǎng)站

docsify

安裝

安裝node拒逮,然后建議全局安裝docsify-cli,有助于在本地初始化和預覽網(wǎng)站炊林。

npm i docsify-cli -g

如果需要部署到gitHub彩倚,則也安裝一下git筹我。

初始化

使用init命令初始化。如果要在./docs子目錄中編寫文檔帆离,則可使用下面命令:

docsify init ./docs
001.png
002.png

上面是執(zhí)行命令過程與自動生成的文件的截圖蔬蕊,下面簡單介紹下docs中的3個文件:

  • .nojekyll:讓gitHub不忽略掉以 _ 打頭的文件
  • index.html:整個網(wǎng)站的核心文件
  • README.md:默認頁面

這里最好只采用docs目錄,官方推薦哥谷,而且將文檔放到gitHub上時岸夯,也必須是docs。

本地預覽文檔

進入docs目錄呼巷,運行本地服務器 docsify serve囱修,然后在瀏覽器中打開 http://localhost:3000即可。

// 如果要預覽的文檔在docs中王悍,則使用 docsify serve 即可破镰。
docsify serve
005.png

也可以不進入docs目錄運行本地服務器:docsify serve docs

gitHub上預覽文檔

應該都知道 gitHub 是放置代碼的網(wǎng)址压储,其實它還有一個強大的預覽文檔的功能鲜漩。如果將 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蔽氨,點擊保存。然后會自動發(fā)布,并且給出發(fā)布的網(wǎng)站地址鹉究。
003.png
004.png
  • 點擊上圖中url:Your site is published at url宇立。意不意外,驚不驚喜呢自赔?反正我第一次我是挺驚喜
  • 以后你只需要寫東西放到該倉庫妈嘹,網(wǎng)站自動會更新。

更多

再次推薦:docsify匿级。

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末蟋滴,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子痘绎,更是在濱河造成了極大的恐慌,老刑警劉巖肖粮,帶你破解...
    沈念sama閱讀 222,000評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件孤页,死亡現(xiàn)場離奇詭異,居然都是意外死亡涩馆,警方通過查閱死者的電腦和手機行施,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,745評論 3 399
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來魂那,“玉大人蛾号,你說我怎么就攤上這事⊙难牛” “怎么了鲜结?”我有些...
    開封第一講書人閱讀 168,561評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長活逆。 經(jīng)常有香客問我精刷,道長,這世上最難降的妖魔是什么蔗候? 我笑而不...
    開封第一講書人閱讀 59,782評論 1 298
  • 正文 為了忘掉前任怒允,我火速辦了婚禮,結果婚禮上锈遥,老公的妹妹穿的比我還像新娘纫事。我一直安慰自己,他們只是感情好所灸,可當我...
    茶點故事閱讀 68,798評論 6 397
  • 文/花漫 我一把揭開白布丽惶。 她就那樣靜靜地躺著,像睡著了一般庆寺。 火紅的嫁衣襯著肌膚如雪蚊夫。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,394評論 1 310
  • 那天懦尝,我揣著相機與錄音知纷,去河邊找鬼壤圃。 笑死,一個胖子當著我的面吹牛琅轧,可吹牛的內(nèi)容都是我干的伍绳。 我是一名探鬼主播,決...
    沈念sama閱讀 40,952評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼乍桂,長吁一口氣:“原來是場噩夢啊……” “哼冲杀!你這毒婦竟也來了?” 一聲冷哼從身側響起睹酌,我...
    開封第一講書人閱讀 39,852評論 0 276
  • 序言:老撾萬榮一對情侶失蹤权谁,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后憋沿,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體旺芽,經(jīng)...
    沈念sama閱讀 46,409評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,483評論 3 341
  • 正文 我和宋清朗相戀三年辐啄,在試婚紗的時候發(fā)現(xiàn)自己被綠了采章。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,615評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡壶辜,死狀恐怖悯舟,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情砸民,我是刑警寧澤抵怎,帶...
    沈念sama閱讀 36,303評論 5 350
  • 正文 年R本政府宣布,位于F島的核電站阱洪,受9級特大地震影響便贵,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜冗荸,卻給世界環(huán)境...
    茶點故事閱讀 41,979評論 3 334
  • 文/蒙蒙 一承璃、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧蚌本,春花似錦盔粹、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,470評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至嵌莉,卻和暖如春进萄,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,571評論 1 272
  • 我被黑心中介騙來泰國打工中鼠, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留可婶,地道東北人。 一個月前我還...
    沈念sama閱讀 49,041評論 3 377
  • 正文 我出身青樓援雇,卻偏偏與公主長得像矛渴,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子惫搏,可洞房花燭夜當晚...
    茶點故事閱讀 45,630評論 2 359

推薦閱讀更多精彩內(nèi)容

  • 第一章 安裝Git工具 下載GitHub for Windows,直接點擊安裝具温,安裝完成后,可以看到“Git Sh...
    不圓的石頭閱讀 11,878評論 5 63
  • 前幾日畫了個人臉筐赔,對素描又有了興趣铣猩。今天專門畫了個眼睛〈剑看看如何剂习? 睫毛,瞳孔较沪,眼瞼幾個特征要畫好,能體現(xiàn)出眼睛的...
    bigboss媽咪閱讀 420評論 3 3
  • 今天又搬家失仁,累的筋疲力盡尸曼,好在有同事的熱心幫忙,大熱的天萄焦,真是辛苦你們了控轿,你們的好我都記下了,廠里的每個人都那么和...
    冰咋吃閱讀 193評論 0 1
  • 你說拂封,我不敢見你茬射, 我說,我不敢見你冒签。 早上睜開眼的剎那在抛, 就在尋你。 晚上睡前的最后一句話萧恕, 需留給你刚梭, 直到不...
    愛那么多閱讀 133評論 0 0
  • 傍晚的湖濱,游人絡繹不絕票唆。晚風襲來朴读,愜意怡人。晚上七點半走趋,湖濱音樂噴泉開始播放衅金。音樂響起,噴泉噴出水花,舞動的水花...
    氧氣姑娘666閱讀 239評論 0 0