香草引导4主题
mkdocs-theme-bootstrap4的Python项目详细描述
MkDocs的bootstrap4主题
一个香草引导4主题。在
截图
快速入门
安装第一个程序包:
$ pip install mkdocs-theme-bootstrap4
然后启用它:
^{pr2}$配置
将这些附加选项放在mkdocs.yml
配置的theme:
部分下,以更改主题的行为。在
# Show next/previous links between pages?next_previous:true
引导功能
一些引导组件需要添加额外的CSS类。要启用这些,请在mkdocs.yml
中添加以下plugins
:
plugins:-bootstrap4-blockquotes-bootstrap4-tables
黑客攻击
首先,安装依赖项:
确保python2在python3之前在您的路径上找到,否则您将在node-gyp
中得到错误。如果无法执行此操作,请将环境变量npm_config_python
设置为一个命令,该命令将启动python2(py -2
(在Windows上,python2
在其他地方)。在
在Windows上:
- 最简单的方法是不把Python放在您的路径上,而是依赖于^{
} CLI 。在 - 您需要安装本机依赖项所需的构建工具:
npm install -g --production windows-build-tools
。在
要在编辑器中完成工作,请在此存储库的根目录中设置一个虚拟环境并安装MkDocs:
$ pip3 install --user --upgrade setuptools twine wheel
$ python3 -m venv venv
$ . venv/bin/activate
$ pip install -r requirements.txt
要以可编辑的形式将插件安装到本地MkDocs站点:
$ pip install --editable /path/to/mkdocs-theme-bootstrap4
正在升级依赖项
要升级依赖项,请安装pip-upgrader
:
. venv/bin/activatepip install -r requirements.dev.txt
然后继续更新依赖项:
pip-upgrade requirements.dev.txt
节点依赖关系可以用Yarn更新:
yarn upgrade
释放
构建可分发包:
$ python3 setup.py sdist bdist_wheel
将其推送到PyPI测试实例:
$ python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
在虚拟环境中进行测试:
$ pip install --index-url https://test.pypi.org/simple/ --no-deps mkdocs-drawio-exporter
让我们开始吧:
$ python3 -m twine upload dist/*
- 项目
标签: