MkDocs Material 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
MkDocs Material 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
MkDocs Material 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」 !
MkDocs Material 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」「最积极运营项目」 !
MkDocs Material 获得 2020 年度 OSC 中国开源项目评选「最积极运营项目」 !
授权协议 MIT
操作系统 跨平台
软件类型 开源软件
开源组织
地区 不详
投 递 者 Alias_Travis
适用人群 未知
收录时间 2021-01-28

软件简介

MkDocs 是快速,简单和华丽的静态网站生成器,可以构建项目文档。文档源文件在 Markdown 编写,使用单个 YAML 配置文件配置。MkDocs 构建的 HTML 网站,可以被托管在 GitHub、Amazon S3 或其他任何位置。

虽然 MkDocs 已经提供了许多漂亮的主题。但 MkDocs Material 将 Android 系统中采用的 Material Design 设计带到了 MkDocs 上。

特征

  • 只是 Markdown ——用普通的 Markdown 写技术文档,无需了解 HTML、JavaScript 或 CSS。MkDocs Material 将会为你进行剩余的繁重工作,并将 Markdown 转换为美观而实用的网站。

  • 响应式设计——底层的 fluid 布局将始终完美地适应屏幕空间。

  • 静态但可搜索 ——技术文档网站可以搜索内容。MkDocs Material 内置搜索,无需服务器就可以立即相应用户的查询。

  • 丰富的配置选项 —— 更改调色板、字体、语言、图示和徽标。添加源仓库链接,可以链接用户个人的社交媒体、Google Analytics 和 Disqus。

  • 真正的国际化 —— MkDocs Material 支持 40多种语言,并为特定语言提供完整的从右到左阅读的支持。

  • 现代体系结构— MkDocs Material 基础代码库使用的是 TypeScript、RxJS 和 SCSS 构建,并使用 Webpack 进行编译,这为主题扩展和自定义提供了更多的可能性。

快速开始

可以通过pip安装 MkDocs Material

pip install mkdocs-material

将以下命令添加进 mkdocs.yml:

theme:
  name: material
展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (0)

加载中
更多评论
暂无内容
发表了博客
2020/08/16 00:00

谈一谈|MkDocs介绍及应用

1 什么是MkDocs MkDocs---markdown项目文档工具,是一个用来创建项目文档的快速、简单、完美的静态站点生成器,文档源码使用Markdown来撰写,用一个yml文件作为配置文档。它具有如下几个优点: 1.1 任意托管 构建完全的静态 HTML 站点 , 可以将它托管到 GitHub pages, Amazon S3 等任意地方。 1.2 大量主题 默认包含大量美观的主题。可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。 1.3 即时预览 内建的开发服...

0
0
2020/10/11 00:00

谈一谈|MkDocs介绍及应用

欢迎点击「算法与编程之美」↑关注我们! 本文首发于微信公众号:"算法与编程之美",欢迎关注,及时了解更多此系列文章。 欢迎加入团队圈子!与作者面对面!直接点击! 1 什么是MkDocs MkDocs---markdown项目文档工具,是一个用来创建项目文档的快速、简单、完美的静态站点生成器,文档源码使用Markdown来撰写,用一个yml文件作为配置文档。它具有如下几个优点: 1.1 任意托管 构建完全的静态 HTML 站点 , 可以将它托管到 GitH...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
0 评论
2 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部