新聞中心
使用mkdocs在Linux上快速搭建文檔網(wǎng)站

創(chuàng)新互聯(lián)長(zhǎng)期為成百上千家客戶提供的網(wǎng)站建設(shè)服務(wù),團(tuán)隊(duì)從業(yè)經(jīng)驗(yàn)10年,關(guān)注不同地域、不同群體,并針對(duì)不同對(duì)象提供差異化的產(chǎn)品和服務(wù);打造開放共贏平臺(tái),與合作伙伴共同營造健康的互聯(lián)網(wǎng)生態(tài)環(huán)境。為薊州企業(yè)提供專業(yè)的成都做網(wǎng)站、成都網(wǎng)站設(shè)計(jì),薊州網(wǎng)站改版等技術(shù)服務(wù)。擁有十載豐富建站經(jīng)驗(yàn)和眾多成功案例,為您定制開發(fā)。
在現(xiàn)代的軟件開發(fā)中,文檔對(duì)于項(xiàng)目的成功至關(guān)重要。隨著軟件和服務(wù)的增加,越來越多的程序員、開發(fā)人員和用戶需要快速找到正確的信息。為了滿足這種需求,許多項(xiàng)目都有自己的文檔網(wǎng)站。
在本文中,我們將介紹如何使用mkdocs在Linux上快速搭建文檔網(wǎng)站。
Mkdocs是一個(gè)Python工具,可以使用Markdown格式構(gòu)建漂亮而響應(yīng)式的文檔網(wǎng)站。它支持自定義主題、語法高亮、導(dǎo)航等功能,并且非常易于使用。此外,mkdocs還支持在本地構(gòu)建站點(diǎn),并支持部署到多種托管服務(wù)上。
以下是如何在Linux上使用mkdocs搭建文檔網(wǎng)站的步驟:
步驟1:安裝Python3
在Linux系統(tǒng)中安裝Python3,可以通過以下命令完成:
“`bash
sudo apt-get update
sudo apt-get install python3
“`
步驟2:安裝pip
pip是Python包管理器,可以用來安裝mkdocs。在Linux系統(tǒng)中安裝pip,可以通過以下命令完成:
“`bash
sudo apt-get install python3-pip
“`
步驟3:安裝mkdocs
通過pip安裝mkdocs,可以通過以下命令完成:
“`bash
sudo pip3 install mkdocs
“`
步驟4:創(chuàng)建一個(gè)新項(xiàng)目
在安裝mkdocs后,我們需要?jiǎng)?chuàng)建一個(gè)新項(xiàng)目。要?jiǎng)?chuàng)建一個(gè)名為my-docs的新文檔網(wǎng)站,可以在終端中執(zhí)行以下命令:
“`bash
mkdocs new my-docs
“`
這將在當(dāng)前目錄中創(chuàng)建名為my-docs的新文件夾,并將其作為新文檔網(wǎng)站的根目錄。
步驟5:驗(yàn)證站點(diǎn)
要驗(yàn)證站點(diǎn)是否在本地工作,請(qǐng)切換到新站點(diǎn)的根目錄,并使用以下命令啟動(dòng)本地服務(wù)器:
“`bash
cd my-docs
mkdocs serve
“`
然后,您可以在瀏覽器中輸入http://localhost:8000查看生成的網(wǎng)站頁面。
步驟6:自定義主題
mkdocs主題可以讓站點(diǎn)更美觀。mkdocs支持多種主題,包括bootstrap、material、windmill等。在mkdocs.yml中配置主題,并通過pip安裝必要的模塊即可。
例如,要在my-docs中使用material主題,請(qǐng)執(zhí)行以下命令:
“`bash
pip install mkdocs-material
“`
然后,將以下行添加到mkdocs.yml文件的頂部:
“`yml
theme:
name: material
“`
步驟7:部署到托管服務(wù)
完成站點(diǎn)后,可以將站點(diǎn)部署到托管服務(wù)上。mkdocs支持多種部署選項(xiàng),包括GitHub pages、Netlify、AWS等。在我們的例子中,我們將站點(diǎn)部署到GitHub pages。
要將站點(diǎn)部署到GitHub pages,請(qǐng)按照以下步驟執(zhí)行:
在命令行中,運(yùn)行以下命令在my-docs文件夾中生成靜態(tài)網(wǎng)站文件:
“`bash
mkdocs build
“`
將生成的site目錄和mkdocs.yml文件添加到Git倉庫中,并推送到GitHub。
在GitHub上,轉(zhuǎn)到您的倉庫設(shè)置,并將GitHub pages設(shè)置為從mn或master分支的/docs文件夾中構(gòu)建。
現(xiàn)在,您的文檔網(wǎng)站應(yīng)該在GitHub上的URL上可用。
結(jié)論
使用mkdocs構(gòu)建文檔網(wǎng)站非常簡(jiǎn)單。經(jīng)過簡(jiǎn)單的設(shè)置,您可以使用Markdown格式構(gòu)建具有專業(yè)外觀的響應(yīng)式站點(diǎn),并將其部署到托管服務(wù)上。無論是您個(gè)人的開源項(xiàng)目,還是企業(yè)的內(nèi)部文檔,mkdocs都是一個(gè)可靠且易于使用的解決方案。
相關(guān)問題拓展閱讀:
- snownlp和nltk什么關(guān)系
snownlp和nltk什么關(guān)系
Awesome XXX 系列資源整理由 vinta 發(fā)起維護(hù)內(nèi)容包括:Web框架、中國絡(luò)爬蟲、中國絡(luò)內(nèi)容提取、模板引擎、數(shù)據(jù)庫、數(shù)據(jù)視化、圖片處理、文本處理、自語言處理、機(jī)器習(xí)、志、代碼析等 伯樂線已 GitHub 發(fā)起「Python 資源全文版」整理歡迎擴(kuò)散、歡迎加入 GitHub – jobbole/awesome-python-cn: Python資源全文版 環(huán)境管理 管理 Python 版本環(huán)境工具 p – 非簡(jiǎn)單交互式圓腔讓 python 版本管理工具 pyenv – 簡(jiǎn)單 Python 版本管理工具 Vex – 虛擬環(huán)境執(zhí)行命令 virtualenv – 創(chuàng)建獨(dú)立 Python 環(huán)境工具 virtualenvwrapper- virtualenv 組擴(kuò)展 包管理 管理包依賴工具 pip – Python 包依賴關(guān)系管理工具 pip-tools – 保證 Python 包依賴關(guān)系更新組工具 conda – 跨平臺(tái)Python 二進(jìn)制包管理工具 Curdling – 管理 Python 包命令行工具 wheel – Python 發(fā)新標(biāo)準(zhǔn)意取代 eggs 包倉庫 本 PyPI 倉庫服務(wù)中國 warehouse – 代 PyPI Warehousebandersnatch – PyPA 提供 PyPI 鏡像工具 devpi – PyPI 服務(wù)打包/測(cè)試/發(fā)工具 localshop – 本 PyPI 服務(wù)(自定義包并且自 PyPI 鏡像) 發(fā) 打包執(zhí)行文件便發(fā) PyInstaller – Python 程序轉(zhuǎn)換獨(dú)立執(zhí)行文件(跨平臺(tái)) dh-virtualenv – 構(gòu)建并 virtualenv 虛擬環(huán)境作 Debian 包發(fā)布 Nuitka – 腳本、模塊、包編譯執(zhí)行文件或橘局?jǐn)U展模塊 py2app – Python 腳本變獨(dú)立軟件包(Mac OS X) py2exe – Python 腳本變獨(dú)立軟件包(Windows) pynsist – 用創(chuàng)建 Windows 安裝程序工具安裝程序打包 Python本身 構(gòu)建工具 源碼編譯軟件 buildout – 構(gòu)建系統(tǒng)組件創(chuàng)建組裝部署應(yīng)用 BitBake – 針嵌入式 Linux 類似 make 構(gòu)建工具 fabricate – 任何語言自找依賴關(guān)系構(gòu)建工具 PlatformIO – 平臺(tái)命令行構(gòu)建工具 PyBuilder – 純 Python 實(shí)現(xiàn)持續(xù)化構(gòu)建工具 SCons – 軟件構(gòu)建工具 交互式解析器 交互式 Python 解析器 IPython – 功能豐富工具非效使用交互式 Python bpython- 界面豐富 Python 解析器 ptpython – 高級(jí)交互式Python解析器 構(gòu)建于python-prompt-toolkit 文件 文件管理 MIME(用途中國際郵件擴(kuò)充協(xié)議)類型檢測(cè) imghdr – (Python 標(biāo)準(zhǔn)庫)檢測(cè)圖片類型 mimetypes – (Python 標(biāo)準(zhǔn)庫)文件名映射 MIME 類型 path.py – os.path 進(jìn)行封裝模塊 pathlib – (Python3.4+ 標(biāo)準(zhǔn)庫)跨平臺(tái)、面向象路徑操作庫 python-magic- 文件類型檢測(cè)第三庫 libmagic Python 接口 Unipath- 用面向象式操作文件目圓陵錄 watchdog – 管理文件系統(tǒng)事件 API shell 工具 期間 操作期間類庫 arrow- 更 Python 期間操作類庫 Chronyk – Python 3 類庫用于解析手寫格式間期 dateutil – Python datetime 模塊擴(kuò)展 delorean- 解決 Python 關(guān)期處理棘手問題庫 moment – 用處理間期Python庫靈自于Moment.js PyTime – 簡(jiǎn)單易用Python模塊用于通字符串操作期/間 pytz – 現(xiàn)代及歷史版本世界區(qū)定義區(qū)數(shù)據(jù)庫引入Python when.py – 提供用戶友函數(shù)幫助用戶進(jìn)行用期間操作 文本處理 用于解析操作文本庫 通用 chardet – 字符編碼檢測(cè)器兼容 Python2 Python3 difflib – (Python 標(biāo)準(zhǔn)庫)幫助我進(jìn)行差異化比較 ftfy – 讓Unicode文本更完整更連貫 fuzzywuzzy – 模糊字符串匹配 Levenshtein – 快速計(jì)算編輯距離及字符串相似度 pangu.py – 韓語字符數(shù)字字母間添加空格 pyfiglet -figlet Python實(shí)現(xiàn) shortuuid – 器庫用簡(jiǎn)潔明白URL 安全 UUID unidecode – Unicode 文本 ASCII 轉(zhuǎn)換形式 uniout – 打印讀字符轉(zhuǎn)義字符串 xpinyin – 用于漢字轉(zhuǎn)換拼音庫 Slug化 awesome-slugify – Python slug 化庫保持 Unicode python-slugify – Python slug 化庫 unicode 轉(zhuǎn)化 ASCII unicode-slugify – slug 工具 unicode slugs ,需要依賴 Django 解析器 phonenumbers – 解析格式化儲(chǔ)存驗(yàn)證電號(hào)碼 P – lex yacc 解析工具 Python 實(shí)現(xiàn) Pygments – 通用語高亮工具 pyparsing – 通用解析器框架 python-nameparser – 名解幾獨(dú)立部 python-user-agents – 瀏覽器 user agent 解析器 sqlparse – 驗(yàn)證 SQL 解析器 特殊文本格式處理 些用解析操作特殊文本格式庫 通用 tablib – 用處理表格數(shù)據(jù)模塊 Office Marmir – 輸入Python 數(shù)據(jù)結(jié)構(gòu)轉(zhuǎn)換電表單 openpyxl – 用讀寫 Excel 2023 xlsx/xl/xltx/xltm 文件庫 python-docx – 讀取查詢及修改 Microsoft Word 2023/2023 docx 文件 unoconv – LibreOffice/OpenOffice 支持任意文件格式間進(jìn)行轉(zhuǎn)換 XlsxWriter – 用于創(chuàng)建 Excel .xlsx 文件 Python 模塊 xlwings – 使 Excel 便調(diào)用 Python 庫(反亦)基于 BSD 協(xié)議 xlwt / xlrd – 讀寫 Excel 文件數(shù)據(jù)格式信息 relatorio – 模板化OpenDocument 文件 PDF PDFMiner – 用于PDF文檔抽取信息工具 PyPDF2 – 割合并轉(zhuǎn)換 PDF 頁面庫 ReportLab – 快速創(chuàng)建富文本 PDF 文檔 Markdown Mistune – 快速并且功能齊全純 Python 實(shí)現(xiàn) Markdown 解析器 Python-Markdown – John Gruber’s Markdown Python 版實(shí)現(xiàn) YAML PyYAML – Python 版本 YAML 解析器 CSV csvkit – 用于轉(zhuǎn)換操作 CSV 工具 Archive unp – 用便解包歸檔文件命令行工具 自語言處理 用處理類語言庫 NLTK – 先進(jìn)平臺(tái)用構(gòu)建處理類語言數(shù)據(jù) Python 程序 jieba – 文詞工具 langid.py – 獨(dú)立語言識(shí)別系統(tǒng) Pattern – Python 中國絡(luò)信息挖掘模塊 SnowNLP – 用處理文文本庫 TextBlob – 進(jìn)行普通自語言處理任務(wù)提供致 API TextGrocery – 簡(jiǎn)單高效短文本類工具基于 LibLinear Jieba 文檔 用項(xiàng)目文檔庫 Sphinx – Python 文檔器 awesome-sphinxdoc MkDocs – Markdown 友文檔器 pdoc – 替換Epydoc 庫自 Python 庫 API 文檔 Pycco – 文編程(literate-programming)風(fēng)格文檔器 配置 用保存解析配置庫 config – logging 模塊作者寫級(jí)配置模塊 ConfigObj – INI 文件解析器帶驗(yàn)證功能 ConfigParser – (Python 標(biāo)準(zhǔn)庫) INI 文件解析器 profig – 通種格式進(jìn)行配置具數(shù)值轉(zhuǎn)換功能 python-decouple – 設(shè)置代碼完全隔離 命令行工具 用于創(chuàng)建命令行程序庫 命令行程序發(fā) cement – Python 命令行程序框架 click – 通組合式創(chuàng)建精美命令行界面包 cliff – 用于創(chuàng)建命令行程序框架創(chuàng)建具層命令命令行程序 clint – Python 命令行程序工具 colorama – 跨平臺(tái)彩色終端文本 docopt – Python 風(fēng)格命令行參數(shù)解析器 Gooey – 條命令命令行程序變 GUI 程序 python-prompt-toolkit – 用于構(gòu)建強(qiáng)交互式命令行程序庫 產(chǎn)力工具 aws-cli – Amazon Web Services 通用命令行界面 bashplotlib – 終端進(jìn)行基本繪圖 caniusepython3 – 判斷哪項(xiàng)目妨礙移植 Python 3 cookiecutter – cookiecutters(項(xiàng)目模板)創(chuàng)建項(xiàng)目命令行工具
沒什埋判伏么關(guān)系吧。 SnowNLP的開沖培發(fā)者在GitHub描述中提到是受TextBlobd的啟發(fā)才寫的SnowNLP,而這彎攜兩個(gè)類庫的更大區(qū)別就是SnowNLP具體實(shí)現(xiàn)的時(shí)候沒有用nltk,主要針對(duì)中文文本處理。
關(guān)于mkdocs linux的介紹到此就結(jié)束了,不知道你從中找到你需要的信息了嗎 ?如果你還想了解更多這方面的信息,記得收藏關(guān)注本站。
成都網(wǎng)站營銷推廣找創(chuàng)新互聯(lián),全國分站站群網(wǎng)站搭建更好做SEO營銷。
創(chuàng)新互聯(lián)(www.cdcxhl.com)四川成都IDC基礎(chǔ)服務(wù)商,價(jià)格厚道。提供成都服務(wù)器托管租用、綿陽服務(wù)器租用托管、重慶服務(wù)器托管租用、貴陽服務(wù)器機(jī)房服務(wù)器托管租用。
本文名稱:使用mkdocs在Linux上快速搭建文檔網(wǎng)站 (mkdocs linux)
網(wǎng)頁網(wǎng)址:http://fisionsoft.com.cn/article/dhjpopj.html


咨詢
建站咨詢
