千鋒教育-做有情懷、有良心、有品質(zhì)的職業(yè)教育機(jī)構(gòu)

手機(jī)站
千鋒教育

千鋒學(xué)習(xí)站 | 隨時(shí)隨地免費(fèi)學(xué)

千鋒教育

掃一掃進(jìn)入千鋒手機(jī)站

領(lǐng)取全套視頻
千鋒教育

關(guān)注千鋒學(xué)習(xí)站小程序
隨時(shí)隨地免費(fèi)學(xué)習(xí)課程

當(dāng)前位置:首頁(yè)  >  技術(shù)干貨  > wiki怎么建?

wiki怎么建?

來(lái)源:千鋒教育
發(fā)布人:xqq
時(shí)間: 2023-10-10 20:19:43 1696940383

一、wiki建設(shè)

1.安裝MkDocs

1.1 Ubuntu系統(tǒng)

sudo apt-get install mkdocs

1.2 Windows系統(tǒng)

MkDocs目前支持Python2.7,3.4,3.6,3.7版本

安裝Python

安裝pip

pip install –upgrade pip

安裝MkDocs

pip install mkdocs

1.3 確認(rèn)是否安裝正確

mkdocs –version

2.創(chuàng)建一個(gè)Wiki

mkdocs new my-wiki

cd my-wiki

docs文件夾下存放的就是自己寫(xiě)的Markdown文章,系統(tǒng)默認(rèn)會(huì)生成一個(gè)index.md文件

mkdocs.yml是wiki網(wǎng)站的配置文件(主題、目錄、語(yǔ)言等)

3.預(yù)覽wiki

首先啟動(dòng)mkdocs服務(wù)

mkdocs serve

然后打開(kāi)瀏覽器輸入127.0.0.1:8000訪(fǎng)問(wèn)wiki

如果以上步驟都執(zhí)行成功,你將看到如下界面:

至此,一個(gè)wiki系統(tǒng)已經(jīng)搭建完成,下面我們來(lái)學(xué)習(xí)一下如何向wiki系統(tǒng)中添加新的內(nèi)容吧!

4.添加新內(nèi)容

4.1 添加新的文字內(nèi)容

首先在docs文件夾下面創(chuàng)建test.md文件,并使用你喜歡的markdown編輯器寫(xiě)入內(nèi)容。

This is a new page.

# 一級(jí)標(biāo)題

## 二級(jí)標(biāo)題

### 三級(jí)標(biāo)題

編輯mkdocs.yml文件,寫(xiě)入以下內(nèi)容:

nav:

??? – Home: index.md

??? – First: first.md

4.2 插入圖片

在docs文件夾下創(chuàng)建images文件夾,并將圖片放入此文件夾,然后在markdown文件中引用:

![mkdocs](images/mkdocs.png)

5.更換主題

mkdocs有多個(gè)主題可供選擇,以滿(mǎn)足不用用戶(hù)的喜好,在此小編向大家推薦Material主題。

5.1 安裝Material主題

pip install mkdocs-material

5.2 配置wiki使用Material主題

打開(kāi)配置文件mkdocs.yml,寫(xiě)入以下內(nèi)容:

theme:

name: ‘material’

6.將你的wiki站點(diǎn)托管到GitHub

創(chuàng)建一個(gè)新倉(cāng)庫(kù)。 比如: https://github.com/user_name/repository_name

初始化你的本地倉(cāng)庫(kù)(wiki), 添加遠(yuǎn)程倉(cāng)庫(kù),提交本地修改并推送到遠(yuǎn)程倉(cāng)庫(kù)

cd my-wiki

git init

git add remote https://github.com/user_name/repository_name

git add .

git commit -m “first commit”

git push origin master

部署你的wiki站點(diǎn)

mkdocs gh-deploy

現(xiàn)在你的wiki站點(diǎn)(HTML文件)在gh-pages分支,你的wiki站點(diǎn)(markdown文件)在master分支。

該命令執(zhí)行了兩個(gè)動(dòng)作:

將Mardown文件轉(zhuǎn)為靜態(tài)HTML網(wǎng)頁(yè)文件

將所有的靜態(tài)HTML網(wǎng)頁(yè)文件都推送到遠(yuǎn)程倉(cāng)庫(kù)的gh-pages分支

GitHub會(huì)自動(dòng)管理gh-pages分支的靜態(tài)網(wǎng)頁(yè),就相當(dāng)于一個(gè)靜態(tài)網(wǎng)站服務(wù)器。

通過(guò)以下網(wǎng)址訪(fǎng)問(wèn)你的wiki

https://user_name.github.io/repository_name

延伸閱讀:

二、wiki是什么

有人認(rèn)為,Wiki系統(tǒng)屬于一種人類(lèi)知識(shí)網(wǎng)格系統(tǒng),可以在Web的基礎(chǔ)上對(duì)Wiki文本進(jìn)行瀏覽、創(chuàng)建、更改,而且創(chuàng)建、更改、發(fā)布的代價(jià)遠(yuǎn)比HTML文本??;同時(shí)Wiki系統(tǒng)還支持面向社群的協(xié)作式寫(xiě)作,為協(xié)作式寫(xiě)作提供必要幫助;最后,Wiki的寫(xiě)作者自然構(gòu)成了一個(gè)社群,Wiki系統(tǒng)為這個(gè)社群提供簡(jiǎn)單的交流工具。與其它超文本系統(tǒng)相比,Wiki有使用方便及開(kāi)放的特點(diǎn),所以Wiki系統(tǒng)可以幫助我們?cè)谝粋€(gè)社群內(nèi)共享某領(lǐng)域的知識(shí)。

WiKi可以調(diào)動(dòng)廣大網(wǎng)民的群體智慧參與網(wǎng)絡(luò)創(chuàng)造和互動(dòng),它是web2.0的一種典型應(yīng)用,是知識(shí)社會(huì)條件下創(chuàng)新2.0的一種典型形式。它也為教師和學(xué)生的知識(shí)共享提供了高效的平臺(tái),實(shí)現(xiàn)了快速?gòu)V泛的信息整合。

聲明:本站稿件版權(quán)均屬千鋒教育所有,未經(jīng)許可不得擅自轉(zhuǎn)載。
10年以上業(yè)內(nèi)強(qiáng)師集結(jié),手把手帶你蛻變精英
請(qǐng)您保持通訊暢通,專(zhuān)屬學(xué)習(xí)老師24小時(shí)內(nèi)將與您1V1溝通
免費(fèi)領(lǐng)取
今日已有369人領(lǐng)取成功
劉同學(xué) 138****2860 剛剛成功領(lǐng)取
王同學(xué) 131****2015 剛剛成功領(lǐng)取
張同學(xué) 133****4652 剛剛成功領(lǐng)取
李同學(xué) 135****8607 剛剛成功領(lǐng)取
楊同學(xué) 132****5667 剛剛成功領(lǐng)取
岳同學(xué) 134****6652 剛剛成功領(lǐng)取
梁同學(xué) 157****2950 剛剛成功領(lǐng)取
劉同學(xué) 189****1015 剛剛成功領(lǐng)取
張同學(xué) 155****4678 剛剛成功領(lǐng)取
鄒同學(xué) 139****2907 剛剛成功領(lǐng)取
董同學(xué) 138****2867 剛剛成功領(lǐng)取
周同學(xué) 136****3602 剛剛成功領(lǐng)取
相關(guān)推薦HOT
標(biāo)識(shí)符的命名規(guī)則?

1.命名方式命名方式主要涉及到標(biāo)識(shí)符的組成和允許使用的字符。通常情況下,標(biāo)識(shí)符可以包括字母、數(shù)字、下劃線(xiàn)和特殊符號(hào)(如美元符號(hào))。然而,...詳情>>

2023-10-10 21:40:51
用戶(hù)多租戶(hù)的測(cè)試用例怎么寫(xiě)?

一、用戶(hù)多租戶(hù)的測(cè)試用例1.功能用例設(shè)計(jì)用戶(hù)多租戶(hù)的接口與客戶(hù)端的功能是對(duì)應(yīng)的,那么這個(gè)接口是否能提供給客戶(hù)端某個(gè)特定功能所需要的數(shù)據(jù)自...詳情>>

2023-10-10 21:28:18
jira怎么管理工時(shí)?

一、jira管理工時(shí)1. 在系統(tǒng)設(shè)置中開(kāi)啟時(shí)間跟蹤功能路徑:系統(tǒng)管理-問(wèn)題-時(shí)間跟蹤。有個(gè)注意的地方是是否開(kāi)啟傳統(tǒng)模式(legacy mode),如果開(kāi)啟...詳情>>

2023-10-10 21:16:00
敏捷開(kāi)發(fā)過(guò)程模型有哪些?

一、敏捷開(kāi)發(fā)過(guò)程模型1、ScrumScrum是最常用的敏捷開(kāi)發(fā)過(guò)程模型之一,它強(qiáng)調(diào)團(tuán)隊(duì)的自組織和自我管理,通過(guò)短周期的迭代開(kāi)發(fā)來(lái)不斷地交付軟件產(chǎn)...詳情>>

2023-10-10 21:03:10
簡(jiǎn)單的bug管理工具怎么開(kāi)發(fā)?

一、簡(jiǎn)單的bug管理工具開(kāi)發(fā)1. 輕量化,即開(kāi)即用,容易上手對(duì)Bug的分類(lèi)是修復(fù)前很重要的一步,因此,要提前做好篩選工作。在輕流的Bug管理方案中...詳情>>

2023-10-10 20:58:13