使用mkdocs在Linux上快速搭建文档网站 (mkdocs linux)

使用mkdocs在Linux上快速搭建文档网站

创新互联长期为成百上千家客户提供的网站建设服务,团队从业经验10年,关注不同地域、不同群体,并针对不同对象提供差异化的产品和服务;打造开放共赢平台,与合作伙伴共同营造健康的互联网生态环境。为蓟州企业提供专业的成都做网站、成都网站设计,蓟州网站改版等技术服务。拥有十载丰富建站经验和众多成功案例,为您定制开发。

在现代的软件开发中,文档对于项目的成功至关重要。随着软件和服务的增加,越来越多的程序员、开发人员和用户需要快速找到正确的信息。为了满足这种需求,许多项目都有自己的文档网站。

在本文中,我们将介绍如何使用mkdocs在Linux上快速搭建文档网站。

Mkdocs是一个Python工具,可以使用Markdown格式构建漂亮而响应式的文档网站。它支持自定义主题、语法高亮、导航等功能,并且非常易于使用。此外,mkdocs还支持在本地构建站点,并支持部署到多种托管服务上。

以下是如何在Linux上使用mkdocs搭建文档网站的步骤:

步骤1:安装Python3

在Linux系统中安装Python3,可以通过以下命令完成:

“`bash

sudo apt-get update

sudo apt-get install python3

“`

步骤2:安装pip

pip是Python包管理器,可以用来安装mkdocs。在Linux系统中安装pip,可以通过以下命令完成:

“`bash

sudo apt-get install python3-pip

“`

步骤3:安装mkdocs

通过pip安装mkdocs,可以通过以下命令完成:

“`bash

sudo pip3 install mkdocs

“`

步骤4:创建一个新项目

在安装mkdocs后,我们需要创建一个新项目。要创建一个名为my-docs的新文档网站,可以在终端中执行以下命令:

“`bash

mkdocs new my-docs

“`

这将在当前目录中创建名为my-docs的新文件夹,并将其作为新文档网站的根目录。

步骤5:验证站点

要验证站点是否在本地工作,请切换到新站点的根目录,并使用以下命令启动本地服务器:

“`bash

cd my-docs

mkdocs serve

“`

然后,您可以在浏览器中输入http://localhost:8000查看生成的网站页面。

步骤6:自定义主题

mkdocs主题可以让站点更美观。mkdocs支持多种主题,包括bootstrap、material、windmill等。在mkdocs.yml中配置主题,并通过pip安装必要的模块即可。

例如,要在my-docs中使用material主题,请执行以下命令:

“`bash

pip install mkdocs-material

“`

然后,将以下行添加到mkdocs.yml文件的顶部:

“`yml

theme:

name: material

“`

步骤7:部署到托管服务

完成站点后,可以将站点部署到托管服务上。mkdocs支持多种部署选项,包括GitHub pages、Netlify、AWS等。在我们的例子中,我们将站点部署到GitHub pages。

要将站点部署到GitHub pages,请按照以下步骤执行:

在命令行中,运行以下命令在my-docs文件夹中生成静态网站文件:

“`bash

mkdocs build

“`

将生成的site目录和mkdocs.yml文件添加到Git仓库中,并推送到GitHub。

在GitHub上,转到您的仓库设置,并将GitHub pages设置为从mn或master分支的/docs文件夹中构建。

现在,您的文档网站应该在GitHub上的URL上可用。

结论

使用mkdocs构建文档网站非常简单。经过简单的设置,您可以使用Markdown格式构建具有专业外观的响应式站点,并将其部署到托管服务上。无论是您个人的开源项目,还是企业的内部文档,mkdocs都是一个可靠且易于使用的解决方案。

相关问题拓展阅读:

  • snownlp和nltk什么关系

snownlp和nltk什么关系

Awesome XXX 系列资源整理由 vinta 发起维护内容包括:Web框架、中国络爬虫、中国络内容提取、模板引擎、数据库、数据视化、图片处理、文本处理、自语言处理、机器习、志、代码析等   伯乐线已 GitHub 发起「Python 资源全文版」整理欢迎扩散、欢迎加入   GitHub – jobbole/awesome-python-cn: Python资源全文版   环境管理   管理 Python 版本环境工具   p – 非简单交互式圆腔让 python 版本管理工具   pyenv – 简单 Python 版本管理工具   Vex – 虚拟环境执行命令   virtualenv – 创建独立 Python 环境工具   virtualenvwrapper- virtualenv 组扩展   包管理   管理包依赖工具   pip – Python 包依赖关系管理工具   pip-tools – 保证 Python 包依赖关系更新组工具   conda – 跨平台Python 二进制包管理工具   Curdling – 管理 Python 包命令行工具   wheel – Python 发新标准意取代 eggs   包仓库   本 PyPI 仓库服务中国   warehouse – 代 PyPI   Warehousebandersnatch – PyPA 提供 PyPI 镜像工具   devpi – PyPI 服务打包/测试/发工具   localshop – 本 PyPI 服务(自定义包并且自 PyPI 镜像)   发   打包执行文件便发   PyInstaller – Python 程序转换独立执行文件(跨平台)   dh-virtualenv – 构建并 virtualenv 虚拟环境作 Debian 包发布   Nuitka – 脚本、模块、包编译执行文件或橘局扩展模块   py2app – Python 脚本变独立软件包(Mac OS X)   py2exe – Python 脚本变独立软件包(Windows)   pynsist – 用创建 Windows 安装程序工具安装程序打包 Python本身   构建工具   源码编译软件   buildout – 构建系统组件创建组装部署应用   BitBake – 针嵌入式 Linux 类似 make 构建工具   fabricate – 任何语言自找依赖关系构建工具   PlatformIO – 平台命令行构建工具   PyBuilder – 纯 Python 实现持续化构建工具   SCons – 软件构建工具   交互式解析器   交互式 Python 解析器   IPython – 功能丰富工具非效使用交互式 Python   bpython- 界面丰富 Python 解析器   ptpython – 高级交互式Python解析器 构建于python-prompt-toolkit   文件   文件管理 MIME(用途中国际邮件扩充协议)类型检测   imghdr – (Python 标准库)检测图片类型   mimetypes – (Python 标准库)文件名映射 MIME 类型   path.py – os.path 进行封装模块   pathlib – (Python3.4+ 标准库)跨平台、面向象路径操作库   python-magic- 文件类型检测第三库 libmagic Python 接口   Unipath- 用面向象式操作文件目圆陵录   watchdog – 管理文件系统事件 API shell 工具   期间   操作期间类库   arrow- 更 Python 期间操作类库   Chronyk – Python 3 类库用于解析手写格式间期   dateutil – Python datetime 模块扩展   delorean- 解决 Python 关期处理棘手问题库   moment – 用处理间期Python库灵自于Moment.js   PyTime – 简单易用Python模块用于通字符串操作期/间   pytz – 现代及历史版本世界区定义区数据库引入Python   when.py – 提供用户友函数帮助用户进行用期间操作   文本处理   用于解析操作文本库   通用   chardet – 字符编码检测器兼容 Python2 Python3   difflib – (Python 标准库)帮助我进行差异化比较   ftfy – 让Unicode文本更完整更连贯   fuzzywuzzy – 模糊字符串匹配   Levenshtein – 快速计算编辑距离及字符串相似度   pangu.py – 韩语字符数字字母间添加空格   pyfiglet -figlet Python实现   shortuuid – 器库用简洁明白URL 安全 UUID   unidecode – Unicode 文本 ASCII 转换形式   uniout – 打印读字符转义字符串   xpinyin – 用于汉字转换拼音库   Slug化   awesome-slugify – Python slug 化库保持 Unicode   python-slugify – Python slug 化库 unicode 转化 ASCII   unicode-slugify – slug 工具 unicode slugs ,需要依赖 Django   解析器   phonenumbers – 解析格式化储存验证电号码   P – lex yacc 解析工具 Python 实现   Pygments – 通用语高亮工具   pyparsing – 通用解析器框架   python-nameparser – 名解几独立部   python-user-agents – 浏览器 user agent 解析器   sqlparse – 验证 SQL 解析器   特殊文本格式处理   些用解析操作特殊文本格式库   通用   tablib – 用处理表格数据模块   Office   Marmir – 输入Python 数据结构转换电表单   openpyxl – 用读写 Excel 2023 xlsx/xl/xltx/xltm 文件库   python-docx – 读取查询及修改 Microsoft Word 2023/2023 docx 文件   unoconv – LibreOffice/OpenOffice 支持任意文件格式间进行转换   XlsxWriter – 用于创建 Excel .xlsx 文件 Python 模块   xlwings – 使 Excel 便调用 Python 库(反亦)基于 BSD 协议   xlwt / xlrd – 读写 Excel 文件数据格式信息   relatorio – 模板化OpenDocument 文件   PDF   PDFMiner – 用于PDF文档抽取信息工具   PyPDF2 – 割合并转换 PDF 页面库   ReportLab – 快速创建富文本 PDF 文档   Markdown   Mistune – 快速并且功能齐全纯 Python 实现 Markdown 解析器   Python-Markdown – John Gruber’s Markdown Python 版实现   YAML   PyYAML – Python 版本 YAML 解析器   CSV   csvkit – 用于转换操作 CSV 工具   Archive   unp – 用便解包归档文件命令行工具   自语言处理   用处理类语言库   NLTK – 先进平台用构建处理类语言数据 Python 程序   jieba – 文词工具   langid.py – 独立语言识别系统   Pattern – Python 中国络信息挖掘模块   SnowNLP – 用处理文文本库   TextBlob – 进行普通自语言处理任务提供致 API   TextGrocery – 简单高效短文本类工具基于 LibLinear Jieba   文档   用项目文档库   Sphinx – Python 文档器   awesome-sphinxdoc   MkDocs – Markdown 友文档器   pdoc – 替换Epydoc 库自 Python 库 API 文档   Pycco – 文编程(literate-programming)风格文档器   配置   用保存解析配置库   config – logging 模块作者写级配置模块   ConfigObj – INI 文件解析器带验证功能   ConfigParser – (Python 标准库) INI 文件解析器   profig – 通种格式进行配置具数值转换功能   python-decouple – 设置代码完全隔离   命令行工具   用于创建命令行程序库   命令行程序发   cement – Python 命令行程序框架   click – 通组合式创建精美命令行界面包   cliff – 用于创建命令行程序框架创建具层命令命令行程序   clint – Python 命令行程序工具   colorama – 跨平台彩色终端文本   docopt – Python 风格命令行参数解析器   Gooey – 条命令命令行程序变 GUI 程序   python-prompt-toolkit – 用于构建强交互式命令行程序库   产力工具   aws-cli – Amazon Web Services 通用命令行界面   bashplotlib – 终端进行基本绘图   caniusepython3 – 判断哪项目妨碍移植 Python 3   cookiecutter – cookiecutters(项目模板)创建项目命令行工具  

没什埋判伏么关系吧。 SnowNLP的开冲培发者在GitHub描述中提到是受TextBlobd的启发才写的SnowNLP,而这弯携两个类库的更大区别就是SnowNLP具体实现的时候没有用nltk,主要针对中文文本处理。

关于mkdocs linux的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。

成都网站营销推广找创新互联,全国分站站群网站搭建更好做SEO营销。
创新互联(www.cdcxhl.com)四川成都IDC基础服务商,价格厚道。提供成都服务器托管租用、绵阳服务器租用托管、重庆服务器托管租用、贵阳服务器机房服务器托管租用。

当前名称:使用mkdocs在Linux上快速搭建文档网站 (mkdocs linux)
网站URL:http://www.mswzjz.com/qtweb/news18/176518.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联