⑴MkDocs是一款静态网页生成工具,使用这款工具可以让用户轻松创建静态网页并进行发布;该工具并不是一个独立的应用程序,用户在使用这款工具之前需要将其进行部署才可以使用;这款工具支持多种部署方式,无论通过哪一种方式进行部署都是非常便捷的;MkDocs是基于Markdown的网页生成工具,因此您可以通过扩展Markdown插件来让这款工具的功能变得更加强大;关于软件的外观,它自带了几种不同风格的主题,你可以按个人喜好选择使用,或者也可以自行创建主题,非常的灵活;需要的朋友欢迎下载。
⑵MkDocs构建完全静态的HTML网站,您可以将其托管在GitHub页面,Amazon S或您选择的任何其他位置。
⑶MkDocs提供了许多漂亮的主题。在内置主题之间进行选择:mkdocs和readthedocs,选择MkDocs主题Wiki页面上列出的第三方主题之一,或构建自己的主题。
⑷工作时预览您的网站
⑸内置的dev-server允许您在编写文档时预览文档。每当您保存更改时,它甚至会自动重新加载并刷新浏览器。
⑹通过自定义主题和/或安装一些插件,使您的项目文档看起来像您想要的样子。
⑺简单易部署,适合拥有各种经验的用户使用,包括初学者也能轻松使用。
⑻通过这款工具可以让用户从Markdown文件上轻松创建静态的html文件。
⑼如果用户需要更多的功能可以使用插件和Markdown扩展来增强MkDocs。
⑽这款工具自带多种特色主题和第三方主题,您也可以自行创建主题。
⑾在这款工具中,您可以在任何支持静态文件的地方发布您创建的HTML文档。
⑿如果您需要创建静态网页的话,那么欢迎您下载这款网页生成工具使用。
⒀使用程序包管理器安装
⒁如果您拥有并使用软件包管理器(例如apt-get,dnf,homebrew, yum,Chocolatey等在系统上安装软件包,则可能需要搜索“
⒂MkDocs”软件包,如果是最新版本,可以使用该版本,请与软件包管理器一起安装(有关详细信息,请参阅系统的文档。就是这样,您完成了!跳至入门。
⒃如果您的程序包管理器没有最新的“ MkDocs”程序包,则仍可以使用程序包管理器来安装“ Python”和“ pip”。然后,您可以使用pip
⒄安装MkDocs。
⒅为了手动安装MkDocs,您需要在系统上安装Python,以及Python包管理器pip。您可以从命令行检查是否已经安装了这些工具:
⒆$ python --version
⒇Python ..
⒈$ pip --version
⒉pip .. from /usr/local/lib/python./site-packages/pip (python .)
⒊MkDocs支持Python版本....和pypy。
⒋安装Python
⒌通过从python.下载适合您系统的安装程序 并运行它来安装Python。
⒍如果要在Windows上安装Python,请确保选中该复选框以将Python添加到您的PATH(如果安装程序提供了这样的选项(默认情况下通常处于关闭状态。
⒎如果您使用的是最新版本的Python,则默认情况下很可能会安装Python软件包管理器pip。但是,您可能需要将pip升级到最新版本:
⒏pip install --upgrade pip
⒐如果您是第一次安装pip,请下载get-pip.py。然后运行以下命令进行安装:
⒑python get-pip.py
⒒安装MkDocs
⒓mkdocs使用pip安装软件包:
⒔pip install mkdocs
⒕现在,您应该mkdocs在系统上安装了该命令。跑去mkdocs --version检查一切正常。
⒖$ mkdocs --version
⒗mkdocs, version ..
⒘如果您希望为MkDocs安装手册页,则点击即用工具可以为您生成并安装它们,只需运行以下两个命令:
⒙pip install click-man
⒚click-man --target path/to/man/pages mkdocs
⒛请参阅点击手册文档,以获取有关为什么pip无法自动生成和安装手册页的说明。
①如果您使用的是Windows,则上述某些命令可能无法立即使用。
②一个快速的解决方案可能是在每个Python命令前添加python -m 这样的命令:
③python -m pip install mkdocs
④python -m mkdocs
⑤对于更永久的解决方案,您可能需要编辑PATH环境变量以包含ScriptsPython安装目录。最新版本的Python包含一个脚本来为您执行此操作。导航至您的Python安装目录(例如C:Python,打开Tools,然后打开
⑥Scripts文件夹,然后win_addpath.py双击该文件来运行该文件。或者,您可以下载脚本并运行它(python
⑦win_addpath.py。
⑧mkdocs new my-project
⑨cd my-project
⑩花一点时间查看为您创建的初始项目。
Ⅰ有一个名为的配置文件mkdocs.yml,一个名为的文件夹 docs将包含您的文档源文件。现在,该docs
Ⅱ文件夹仅包含一个名为的文档页面index.md。
ⅢMkDocs带有内置的开发服务器,可让您在处理文档时对其进行预览。确保您与mkdocs.yml 配置文件位于同一目录中,然后通过运行以下mkdocs
Ⅳserve 命令来启动服务器:
Ⅴ$ mkdocs serve
ⅥINFO - Building documentation...
ⅦINFO - Cleaning site directory
Ⅷ[I :: server:] Serving on
Ⅸ[I :: handlers:] Start watching changes
Ⅹ[I :: handlers:] Start detecting changes
㈠在浏览器中打开,您将看到默认的主页显示:
㈡开发服务器还支持自动重装,并且只要配置文件,文档目录或主题目录中的任何内容发生更改,都将重建您的文档。
㈢docs/index.md在您选择的文本编辑器中打开文档,将初始标题更改为MkLorum,然后保存您的更改。您的浏览器将自动重新加载,您应该立即看到更新的文档。
㈣现在尝试编辑配置文件:mkdocs.yml。将site_name设置更改 为MkLorum并保存文件。
㈤site_name: MkLorum
㈥您的浏览器应立即重新加载,并且您会看到新的网站名称生效。
㈦现在将第二页添加到您的文档中:
㈧curl '' >
㈨docs/about.md
㈩由于我们的文档站点将包含一些导航标题,因此您可能需要编辑配置文件,并通过添加nav
设置在导航标题中添加有关每个页面的顺序,标题和嵌套的一些信息:
site_name: MkLorum
- Home: index.md
- About: about.md
保存所做的更改,您现在将看到一个导航栏,其中带有Home和的About
项目位于左侧Search,而Previous,,以及Next项目位于右侧。
尝试菜单项,然后在页面之间来回导航。然后点击
Search。将出现一个搜索对话框,使您可以搜索任何页面上的任何文本。请注意,搜索结果包括网站上搜索词的所有出现,并直接链接到搜索词出现的页面部分。您可以毫不费力地完成所有工作!
主题化我们的文档
现在更改配置文件,以通过更改主题来更改文档的显示方式。编辑mkdocs.yml文件并添加theme设置:
site_name: MkLorum
- Home: index.md
- About: about.md
theme: readthedocs
保存所做的更改,您将看到正在使用ReadTheDocs主题。
默认情况下,MkDocs使用MkDocs图标图标。要使用其他图标,请在中创建一个img子目录,docs_dir然后将自定义favicon.ico文件复制到该目录。MkDocs将自动检测该文件并将其用作您的收藏夹图标。
很好看 您已经准备好部署MkLorum 文档的第一阶段。首先构建文档:
mkdocs build
这将创建一个名为的新目录site。看一下目录:
$ ls site
about fonts index.html license search.html
css img js mkdocs sitemap.xml
请注意,您的源文档已作为两个名为index.html和的HTML文件输出
about/index.html。您还可以将其他各种媒体site作为文档主题的一部分复制到目录中。您甚至还有一个sitemap.xml文件和mkdocs/search_index.json。
如果您正在使用源代码控制,例如,git您可能不想检查文档库在存储库中的构建。site/在.gitignore文件中添加一行 。
echo "site/" >> .gitignore
如果您使用的是其他源代码控制工具,则需要查看其有关如何忽略特定目录的文档。
一段时间后,文件可能会从文档中删除,但仍将保留在site目录中。要删除这些过时的文件,只需mkdocs 使用该--clean开关即可运行。
mkdocs build --clean
还有其他各种命令和选项。有关命令的完整列表,请使用--help标志:
mkdocs --help
要查看给定命令可用的选项列表,请将该--help标志与该命令一起使用。例如,要获取该build命令可用的所有选项的列表,请 运行以下命令:
mkdocs build --help
您刚刚构建的文档站点仅使用静态文件,因此您几乎可以从任何地方托管它。GitHub项目页面和Amazon
S可能是不错的托管选项,具体取决于您的需求。将整个site目录的内容上传到托管网站的任何位置。