MkDocs 文档编辑器
http://www.mkdocs.org/
安装
pip install mkdocs
基本命令
命令 | 描述 |
---|---|
mkdocs new [dir-name] | 新建一个项目 |
mkdocs serve | 开启网页服务 |
mkdocs build | 创建静态网站 |
mkdocs help | 帮助文档 |
注意,new会在当前目录下建立项目文档,serve/build都要在项目目录下执行
配置信息
配置信息在工程目录下mkdocs.yml中修改,格式是字典格式
参数 | 描述 |
---|---|
site_name | 网页标签名 |
site_url | Set the canonical URL of the site. This will add a link tag with the canonical URL to the generated HTML header. |
repo_url | 将会添加github或者Bitbucket链接 |
repo_name | 同上 |
edit_uri | |
site_description | |
site_description | meta标签 |
site_author | meta标签 |
site_favicon | 设置ico,需要将ico文件放在docs/目录下 |
copyright | 设置版权信息 |
google_analytics | 设置谷歌站点分析工具 |
remote_branch | |
remote_name | |
pages | 设置路径 |
theme | 设置主题,readthedocs |
theme_dir | 设置主题路径 |
docs_dir | |
site_dir | |
extra_css | |
extra_javascript | |
extra_templates | |
extra | |
use_directory_urls | |
strict | |
dev_addr | |
markdown_extensions |
安装第三方主题
windmill主题
下载:
pip install mkdocs-windmill
在mkdocs.yml配置文件中配置主题:
theme: windmill
extra:
logo: logo的路径
version: 版本说明
article_nav_top: 默认为true,是否显示上方的Previous/Next 按钮
article_nav_bottom: 默认为true,是否显示下方的Previous/Next 按钮
history_buttons: 默认为true,是否显示历史记录
修改模板
MkDocs 文档编辑器相关推荐
- PowerDesigner(九)-模型文档编辑器(生成项目文档)
模型文档编辑器 PowerDesigner的模型文档(Model Report)是基于模型的,面向项目的概览文档,提供了灵活,丰富的模型文档编辑界面,实现了设计,修改和输出模型文档的全过程. 模型文 ...
- sscanf 连续相同编辑符_【第1995期】钉钉文档编辑器的前世今生
前言 编辑器,一个重前端的领域方向.今日早读文章由钉钉@展新授权分享. @展新,来自钉钉文档团队.2011 年加入支付宝,一路成长于支付宝的前端团队,孵化了语雀,2018 年到钉钉,开启钉钉文档的旅程 ...
- 编辑器未包含main类型_利用 ONLYOFFICE 将在线文档编辑器集成到 Python Web 应用程序中...
通过 API,开发人员可以将 ONLYOFFICE 编辑器集成到网站和利用程序设计语言编写的应用程序中,并能配置和管理编辑器. 来源:https://linux.cn/article-13037-1. ...
- 九、模型文档编辑器(生成项目文档)
模型文档编辑器 PowerDesigner的模型文档(Model Report)是基于模型的,面向项目的概览文档,提供了灵活,丰富的模型文档编辑界面,实现了设计,修改和输出模型文档的全过程. 模型文 ...
- 自己用js做的在线word文档编辑器oarword-doc/docx文档编辑、导出导出
分享自己用js做的在线word文档编辑器oarword 支持基本doc/docx文档编辑,导出和导出,类似google docs和zoho 源码分享在Github:https://github.com ...
- 转战 Typora Mackdown 文档编辑器
转战 Typora Mackdown 文档编辑器 经历 为什么放弃MWeb 止步于此了吗 再次选择它<Typora> 最后的狂欢 经历 <MWeb> MackDown文档编辑器 ...
- 文档编辑器与远端文件存储(Summernote)
文档编辑器与远端文件存储 summernote编辑器实现图片上传服务器并返回图片虚拟地址 具体步骤如下: 1.在STS中创建spring boot项目,设置其项目结构为project explorer ...
- DCWriter 电子病历文档编辑器的 电子病历功能规范对照表
DCWriter 电子病历文档编辑器的 电子病历功能规范对照表 DCWriter能实现国家制定的<电子病历功能规范>中的针对病历文档编辑器而制定的大部分功能需求,主要有: 电子病历功能规范 ...
- 06_多窗口文档编辑器(小钱版)[Qt开发][2012-03-07]
1) 引言 -> 模块01:程序简要说明 1. 程序名称:多窗口文档编辑器(Multiple Text Editor) 2. 运行环境:Window NT / 2000 / XP / VISTA ...
最新文章
- Matlab符号计算结果过长无法在屏幕中显示的问题
- 7 款从 HTML 文档提取文本的工具
- AAAI 2019 Oral | 把Cross Entropy梯度分布拉‘平’,就能轻松超越Focal Loss
- 使用JDK 13查看TLS配置
- JQuery中淡出和淡入动画效果
- 转:10分钟掌握XML、JSON及其解析
- Android之 震动(Vibrator)如何贯通Android系统 (从硬件设计 -- 驱动 -- HAL -- JNI -- Framework -- Application)
- 学计算机自考商务英语本科好吗,自考本科商务英语专业真的难吗
- 最新苹果CMSV10视频电影网站源码+自适应手机版
- 使用ANSYS进行对称边界的模态分析,制作【春节快乐】
- 视频解析网站 服务器上,视频云解析服务器上
- pythonsin怎么表示_Python numpy.sin()用法及代码示例
- 网易云音乐的亏损,是社区经济的通病?
- 想学3dmax应该怎么学?
- 港科百创 | 9位入选2022福布斯30Under30
- python+微信+腾讯智能闲聊
- centos7下搭建nextcloud云(使用阿里云轻量服务器+oss对象储存)
- 【opencv450-samples】delaunay 三角剖分和 voronoi 细分
- 唯品会RPC服务框架与容器化演进--转
- Unicode 与前端字符编码全揭秘
热门文章
- Python+Pandas读取Excel文件分析关系最好的两个演员
- 使用Python完美管理和调度你的多个任务
- Python标准库base64用法简介
- Python实现图像空域随机水印加入与提取
- Python数据可视化案例一:自定义曲线频率、颜色与线型
- Python_今天是今年第几天
- linux 源码搭建lnmp_详解CentOS 7.0源码包搭建LNMP 实际环境搭建
- python class用法理解_通过钢铁侠变身快速理解Python的装饰器用法
- 明机器人孔尧是哪里人_明机器人孔尧:希望未来打造场景机器人交流平台
- linux从表中提取信息,如何用Linux命令提取表格文本中的某列