如何进入npm_如何用docsify在Github搭建自己的知识文档?
安裝前提
確認電腦已經安裝好 node 和 npm 環境。如果還沒有裝好,那需要執行下面的步驟:1.進入官網:https://nodejs.org/zh-cn/ , 下載長期支持版。
2.安裝就直接下一步就可以了,默認會把環境變量添加進去。
3.直到finish,打開cmd命令行,查看環境變量以及版本。(此時你們看到的應該還是只把node.js的根目錄添加到環境變量path)
4.運行命令修改npm的文件夾前綴和緩存目錄,配置鏡像站。
npm?config?set?prefix?"D:\nodejs\node_global"npm?config?set?cache?"D:\nodejs\node_cache"
npm?config?set?registry=http://registry.npm.taobao.org
然后使用npm config list就可以看到自己的配置:
還需要增加一個環境變量,是node的modules的環境變量(我的nodejs在D盤根目錄下,你們的要自己根據實際情況):
D:\nodejs\node_global\node_modules5.然后如果使用npm安裝了東西,但是找不到該命令,則還需要在Path中,把我們node的全局文件夾添加進去環境變量中。
D:\nodejs\node_global這樣我們就可以愉快的安裝東西了。
docsify走起
官網:https://docsify.js.org/#/
廢話我就不多說了,直接安裝docsify-cli :
npm?i?docsify-cli?-g然后我們建立一個測試文件夾叫note,命令行進入這個文件夾:
cd?notedocsify?init?./docs
就成功了!!!看到它叫你執行命令,本地啟動一下:
docsify?serve?./docs這樣就可以在本地http://localhost:3000打開了,神奇~(修改內容后保存就可以,不需要重新啟動)
美化一下
說實在話,挺丑的,那就美化一下:先加一個封面,需要在`index.html中,把下面的屬性設置為true
coverpage:?true然后新建一個文件_coverpage.md:
# Mybatis摸索之路> 這是我自己的筆記啊啊啊啊
[CSDN](https://blog.csdn.net/Aphysia)
[滾動鼠標](#introduction)
然后它就變成這樣了:
我們還需要一個側邊欄,再將側邊欄屬性打開:
loadSidebar:?true然后新建一個側邊欄的文件_sidebar.md:
- Note- [第一章節](第一章節.md)
- [第二章節](第二章節.md)
- [第三章節](第三章節.md)
然后就變成這樣了:
其中中間那部分使用的是README.md的內容,其他的index.html的內容如下(自己根據需要設置,如果有更高級的需求,建議去官網查文檔!!!)
html><html?lang="en">
<head>
??<meta?charset="UTF-8">
??<title>docsify-demotitle>
??<meta?http-equiv="X-UA-Compatible"?content="IE=edge,chrome=1"?/>
??<meta?name="description"?content="Description">
??<meta?name="viewport"content="width=device-width,?user-scalable=no,?initial-scale=1.0,?maximum-scale=1.0,?minimum-scale=1.0">
??<link?rel="stylesheet"?href="//unpkg.com/docsify/lib/themes/vue.css">
head>
<body>
??<div?id="app">div>
??
??<script?src="//unpkg.com/docsify-edit-on-github/index.js">script>
??
??<script?src="//unpkg.com/prismjs/components/prism-java.js">script>
?
?<script?src="https://cdn.bootcss.com/docsify/4.5.9/plugins/search.min.js">script>
?
??<script?src="//unpkg.com/docsify-copy-code">script>
??
??<script?src="//unpkg.com/docsify/lib/plugins/zoom-image.js">script>
??
??<script?src="//unpkg.com/docsify-count/dist/countable.js">script>?
??<script>window.$docsify?=?{name:?'docsify-demo',repo:?'https://github.com/Damaer/Mybatis-Learning',maxLevel:?5,//最大支持渲染的標題層級subMaxLevel:?3,homepage:?'README.md',coverpage:?true,loadSidebar:?true,auto2top:?true,//切換頁面后是否自動跳轉到頁面頂部//全文搜索search:?{maxAge:?86400000,?//?過期時間,單位毫秒,默認一天paths:?'auto',placeholder:?'搜索',noData:?'找不到結果',//?搜索標題的最大程級,?1?-?6depth:?3,
??????}
????}script>
??<script?src="//unpkg.com/docsify/lib/docsify.min.js">script>
body>
html>
如何部署到github
下面講講如何部署,首先我們需要有一個遠程的倉庫,我默認你有了,使用命令初始化文件夾,關聯遠程倉庫
git?initgit?remote?add?origin?"自己在三方代碼托管平臺上所創建倉庫對應的地址"
push代碼到遠程倉庫就可以了,git的操作就不仔細講了,或者自己把遠程的倉庫先clone下來,再用docsify創建文檔,然后提交,也是ok的。
提交上去之后,我們需要做一個操作,在settings下有一個GitHub Pages,選擇構建分支和文件目錄即可。我使用的是master,根目錄的docs文件夾。然后你就可以看到已經發布成功了,直接訪問網址就可以。
PS:項目是我的其他項目地址,但是流程是一致的。
坑點
我打不開網址!!!是因為電信會屏蔽一些網站,也就是被qiang了,懂的都懂,如果要訪問的話,可以修改DNS,或者搞一把梯_子。
【作者簡介】:
秦懷,公眾號【秦懷雜貨店】作者,技術之路不在一時,山高水長,縱使緩慢,馳而不息。這個世界希望一切都很快,更快,但是我希望自己能走好每一步,寫好每一篇文章,期待和你們一起交流。如果有幫助,求個 贊 和 在看 ,對我,是莫大的鼓勵和認可,讓我更有動力持續寫出好文章。
此文章僅代表自己(本菜鳥)學習積累記錄,或者學習筆記,如有侵權,請聯系作者核實刪除。人無完人,文章也一樣,文筆稚嫩,在下不才,勿噴,如果有錯誤之處,還望指出,感激不盡~
- END -總結
以上是生活随笔為你收集整理的如何进入npm_如何用docsify在Github搭建自己的知识文档?的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: python接口测试类型_python
- 下一篇: 骁龙660是32位还是64位_骁龙660