Sphinx+github+ReadtheDocs書寫筆記
896
2022-05-30
摘要:
對(duì)于軟件人員寫筆記的人來說,markdown格式的筆記更好的展示內(nèi)容的信息,包含表格,代碼塊,注釋塊,插入鏈接等操作,這些操作在word上實(shí)現(xiàn)以來是比較麻煩的,目前采用Typora+PicGo + Gitee(碼云)實(shí)現(xiàn)高效markdown圖床,這個(gè)方案是比較好的,Typora是在MardDown編輯方面是比較強(qiáng)大的,而且軟件也比較小,PicGo是開源的圖床服務(wù)器,Gitee是國內(nèi)的github,訪問速度快,比github好。說了這么多,下面具體說明如何操作。
1:安裝PicGO圖床
PicGO-:
https://github.com/Molunerfinn/PicGo
github上的網(wǎng)址比較慢,大家耐心等等,下完之后,進(jìn)行安裝,安裝完成后打開,軟件界面如下:
選擇最底下的插件設(shè)置,輸入gitee選擇,安裝上傳到gitee的插件腳本,下面是已經(jīng)安裝好的界面
不過這里要注意的是,安裝這個(gè)插件需要node.js,主要是因?yàn)镻icGO這個(gè)軟件是基于node.js,用electron做的客戶端。
2:建立GItee圖床,目的是讓PicoGo上的圖片自動(dòng)保存到gitee上
打開gitee,鏈接地址:https://gitee.com/
進(jìn)入碼云Gitee,自行注冊(cè)登錄,然后點(diǎn)右上角“+”
點(diǎn)擊“新建倉庫”
自定義一個(gè)倉庫名稱,倉庫的地址一定要注意,后面圖床設(shè)置的時(shí)候要用到。
設(shè)置為“開源”,這個(gè)意思就是公開
勾選“使用Readme文件初始化這個(gè)倉庫”
分支模型,選“單分支模型(只創(chuàng)建master分支)”
點(diǎn)擊“創(chuàng)建”
具體操作如下圖所示:
還有配置信息,這個(gè)配置信息要注意,這里面的信息內(nèi)容等下要跟圖床設(shè)置里面的內(nèi)容要一致,不然圖片無法上傳。
創(chuàng)建完成之后,查看倉庫信息,新建里面專門用來存放圖片的文件夾PicGO-updata-img
目前已經(jīng)創(chuàng)建好了文件夾,為了能夠放PicGO自動(dòng)把文件上傳過來,還需要Gitee的私人密鑰,私人密鑰的獲取在gitee的帳號(hào)里面設(shè)置,進(jìn)入到個(gè)人中心里面,點(diǎn)擊私人令牌
在私人令牌的權(quán)限里面,只需要勾選projects。
生成的密鑰要記住保存。
回到PicGO,進(jìn)行圖床配置。
至此,配置完成結(jié)束。
3:安裝Typora
官方-:https://www.typora.io/
安裝完成之后,打開軟件,整個(gè)界面相當(dāng)?shù)暮唵握麧崳?軟件界面如下:
為了在typora里面,插入圖片后,自動(dòng)把圖上上傳到PicGO,然后同步更新到gitee,需要設(shè)置Typora的偏好設(shè)置。設(shè)置方式如下:點(diǎn)擊文件--偏好設(shè)置
在偏好設(shè)置里面---點(diǎn)擊圖像,將圖像的信息直接轉(zhuǎn)變成URL網(wǎng)址地址連接
為了驗(yàn)證圖片能否正常上傳到圖床,可以點(diǎn)擊驗(yàn)證圖片上傳選項(xiàng),來驗(yàn)證設(shè)置是否正常。
當(dāng)我們插入圖片的時(shí)候,電腦右下角出現(xiàn)上傳成功的字樣
至此,Typora設(shè)置完成
4:總結(jié)
目前這套方案經(jīng)過驗(yàn)證,非常適合寫博客或者論壇發(fā)帖文章,使用Snipaste來截圖,插入到Typora寫的MaekDown文檔中,圖片會(huì)通過PicGO圖床自動(dòng)更新到Gitee中,再也不用擔(dān)心圖片丟失的問題了。這篇文章就是通過這樣的組合方式來編寫。歡迎關(guān)注?。。?/p>
Git Markdown
版權(quán)聲明:本文內(nèi)容由網(wǎng)絡(luò)用戶投稿,版權(quán)歸原作者所有,本站不擁有其著作權(quán),亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實(shí)的內(nèi)容,請(qǐng)聯(lián)系我們jiasou666@gmail.com 處理,核實(shí)后本網(wǎng)站將在24小時(shí)內(nèi)刪除侵權(quán)內(nèi)容。