MkDocs是快速,简单和华丽的静态网站生成器,可以构建项目文档。文档源文件在Markdown编写,使用单个YAML配置文件配置。MkDocs构建的HTML网站,可以被托管在GitHub、AmazonS3或其他任何位置。
虽然MkDocs已经提供了许多漂亮的主题。但 MkDocsMaterial将Android系统中采用的 MaterialDesign设计带到了MkDocs 上。
特征只是Markdown——用普通的Markdown写技术文档,无需了解HTML、JavaScript或CSS。MkDocsMaterial将会为你进行剩余的繁重工作,并将Markdown转换为美观而实用的网站。
响应式设计——底层的fluid布局将始终完美地适应屏幕空间。
静态但可搜索——技术文档网站可以搜索内容。MkDocsMaterial内置搜索,无需服务器就可以立即相应用户的查询。
丰富的配置选项—— 更改调色板、字体、语言、图示和徽标。添加源仓库链接,可以链接用户个人的社交媒体、GoogleAnalytics和Disqus。
真正的国际化—— MkDocsMaterial支持40多种语言,并为特定语言提供完整的从右到左阅读的支持。
现代体系结构—MkDocsMaterial基础代码库使用的是TypeScript、RxJS和SCSS构建,并使用Webpack进行编译,这为主题扩展和自定义提供了更多的可能性。
快速开始可以通过pip安装MkDocsMaterial
pipinstallmkdocs-material将以下命令添加进 mkdocs.yml:
theme:name:material
评论