Mkdocs-Wcowin博客主题

已于 2024-06-19 22:35:49 修改
阅读量844 收藏 11
点赞数 13
分类专栏： Mkdocs系列教程 技术分享 文章标签： 前端 github markdown
于 2024-02-21 15:55:54 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_63203517/article/details/136213527
版权

Mkdocs-Wcowin主题

  • 通过主题和目录以打开文章
  • 基于Material for MkDocs美化
    • 简洁美观，功能多元化
    • 简单易上手，小白配置
  • 教程详细，清晰易懂

展示

感受一下它的简洁美观：Mkdocs-Wcowin主题
在这里插入图片描述

主页
1

文章页
1

博客页

标签页
img

简洁的友链页面
1

页面底部
1

如何快速使用

打开终端安装mkdocs: pip install mkdocs-material，在你本地的文件夹下(我的就是Wcowin.github.io这个文件夹)的终端执行git clone git@github.com:Wcowin/Mkdocs-Wcowin.git克隆本模版到本地

把Mkdocs-Wcowin文件里的文件复制出来到Wcowin.github.io文件里，随后在Wcowin.github.io文件目录终端里mkdocs serve即可
在这里插入图片描述

详细的初步教程见：利用Mkdocs部署静态网页至GitHubpages

Connect with me

MuseLink

Star History

在这里插入图片描述

感谢各位朋友

Wcowin
关注
专栏目录
mkdocs-awesome-pages-plugin：一个MkDocs插件，可简化页面标题及其顺序的配置
02-04
MkDocs真棒页面插件 一个MkDocs插件，可简化页面标题及其顺序的配置 该真棒-网页插件允许您自定义您的网页出现在您的MkDocs的导航，而无需配置您的完整结构mkdocs.yml 。 它使用直接放在文档相关目录中的小型配置文件为您提供详细控制。 注意：如果您的mkdocs.yml定义了nav或pages条目，则此插件将不执行任何操作。 要使用下面列出的功能，您必须完全删除条目或。 安装 注意：此软件包需要Python> = 3.5和MkDocs 1.0或更高版本。 如果您仍在使用MkDocs 0.17，请使用 。 用pip安装软件包： pip install mkdocs-aw
mkdocs-custommill:出色的mkdocs主题，侧重于导航，自定义和可用性
03-31
CustomMill主题 关于MkDocs令人敬畏的的又一次迭代。 这是麻省理工学院许可证所允许的。 强调： 大型文档项目的便捷导航。 跨页面过渡保留导航菜单的状态。 文档文件夹的深层嵌套 使用术语突出显示进行搜索。 用户可以在快速下拉列表中搜索或在整页中加载结果。 页面内的默认mkdocs主题，包括语法突出显示。 通过Sass自定义着色 快速开始 要使用pip安装： pip install mkdocs-custommill 要在mkdocs.yml使用： theme : custommill 演示和文档 看到的演示和一些文档:) 发展 如果在mkdocs-custommill上进行开发，请使用进行检查 git clone https://github.com/Siphalor/mkdocs-custommill/ cd mkdocs-custommill
3.配置MkDocs
最新发布
qq_38641599的博客
07-10 387
MkDocs项目只有一个配置文件，使用yml格式。配置文件的作用是修改网站样式、启用功能、启用插件。MkDocs的大部分功能是关闭的，需要用户在配置文件中开启。​ 配置文件，你可以轻松启用常用的 Markdown 语法拓展和插件，使你的文档网站功能更加丰富和易于使用。
mkdocs-basic-theme:一个非常简单的MkDocs主题示例
05-07
MkDocs基本主题 这是MkDocs的最小主题示例。 您可以看到它与本文档的构建一起运行。 但是，请注意，它仅用作代码示例，而不是可用主题的示例。
【小沐学Python】Python实现在线电子书制作（MkDocs + readthedocs + github + Markdown）
爱看书的小沐
06-10 2795
MkDocs是一个快速、简单、华丽的静态网站生成器，适用于构建项目文档。文档源文件以Markdown编写，并使用一个YAML文件来进行配置。在任何地方部署MkDocs生成完全静态的HTML网站，你可以将其部署到GitHub pages、Amzzon S3或你自己选择的其它任意地方。很棒的主题MkDocs有一堆很好看的主题。官方内置了两个主题：mkdocs和readthedocs，也可以从MkDocs wiki中选择第三方主题，或者自定义主题。实时预览你的网站。
使用mkdocs搭建文档系统（使用material主题美化）
nonlinearthink的博客
04-02 7713
material是一个mkdocs主题，它的优点： 谷歌的material设计风格。 渐进式布局，可以适配各种设备访问。 支持非常多的插件和扩展，个人试过不少mkdocs主题，material的可扩展性是最好的。 安装 pip install mkdocs-material 在配置文件中添加: theme: name: 'material' 配置 放一个我的配置文件： the...
pvme.github.io:使用mkdocs素材主题自动生成的pvme-guides文档
04-16
PVME文件 PVME-Docs（ ）是从存储库生成的静态站点。 该网站是使用生成的。 变更日志 要求 Python 安装Pipfile所需的python版本 Pipenv pip install pipenv 用于从Pipfile和Pipfile.lock创建虚拟环境 安装 设置 pipenv install 这将使用Pipfile.lock将软件包及其依赖项（固定版本号）。 环境变量 可以设置以下环境变量，以便在本地测试API功能： GS_URL GS_PRIVATE_KEY GS_CLIENT_EMAIL GS_TOKEN_URI *设置环境变量不是强制性的。 发展 建议遵循.github/workflows/ci.yml描述的步骤，以.github/workflows/ci.yml有关如何克隆存储库和运行测试等的概述。 安装新软件包 pipenv install pa
（三）MkDocs学习——配置主题
weixin_44639164的博客
12-29 2925
https://mkdocs.zimoapps.com/user-guide/styling-your-docs/ Choosing Your Theme - MkDocs MkDocs包括一些内置主题以及各种第三方主题，所有这些都可以使用额外的CSS或JavaScript轻松定制，或者覆盖主题的custom_dir。 您也可以为你的文档从头开始创建自己的自定义主题。 要使用MkDocs中包含的主题，只需将其添加到您的mkdocs.yml配置文件中。 theme: readthedocs 使用下面的 .
（四）MkDocs学习——自定义主题
weixin_44639164的博客
12-29 1962
如果您想对现有主题进行一些调整，则无需从头开始创建自己的主题。对于只需要一些CSS和（或）JavaScript的小调整，您可以使用docs_dir。但是，对于更复杂的自定义（包括覆盖模板），您需要使用主题的custom_dir设置。 使用docs_dir extra_css和extra_javascript配置选项可用于对现有主题进行调整和自定义。要使用它们，您只需要在[文档目录]中包含CSS或JavaScript文件。 例如，要更改文档中标题的颜色，请创建一个名为extra.css的文件，并将其放在文档M
推荐开源项目：自定义 MkDocs 主题与增强功能
gitblog_00088的博客
06-17 421
推荐开源项目：自定义 MkDocs 主题与增强功能 项目地址:https://gitcode.com/bmob/BmobDocs 项目介绍 该项目是一个针对 MkDocs 的深度定制解决方案，它不仅提供了一个整洁美观的文档主题，还允许用户自定义页面的 HTML 标题，以满足不同场景下的文档展示需求。通过简单的配置和Markdown编写，你可以创建出专业且个性化的技术文档库。 项目技术分析 MkDo...
mkdocs+mermaid主题增加内容选项卡
ZHAOJUNWEI08的专栏
02-23 418
mkdocs,mermaid
mkdocs-material, 面向MkDocs的材料设计主题.zip
10-11
mkdocs-material, 面向MkDocs的材料设计主题 用于MkDocs的MkDocs的材质设计主题。 快速启动使用 pip 安装最新版本的物料：pip install mkdocs-material将以下行附加到项目的mkdocs.yml:
MkDocs-Theme-Cinder-Superhero:MkDocs的Cinder主题的超级英雄风格修改
05-01
煤渣+超级英雄 基于Cinder的MKDocs超级英雄风格的黑暗主题 煤渣： ： 超级英雄： ： MKDocs： ://www.mkdocs.org 该mkdocs项目的实时版本托管在github页面上 这是文档的样子： 用法： 根据安装MKDocs 运行mkdocs serve托管您的文档的实时版本，请在观看它们 运行mkdocs build以从site内部的文档制作静态网页 编辑文档中的降价文件， docs ，使自己的文档 为什么？ 为什么？？？ 最初的Cinder实现很棒，但有一些设计决策已在此处修复： 对于具有隐私意识的实现，我们不需要任何外部链接。 因此，已删除或完全嵌入了CDN或其他来源（谷歌等）加载的所有上下文。 这个MKDocs主题现在具有隐私意识！ Cinder非常明亮的外观不适合我们喜欢深色外观的面向编程的颜色样式。 作为参考，超级英雄实现是窃取
mkdocs-rtl:基于mkdocs-material的mkdocs rtl主题
05-03
mkdocs-rtl 基于波斯语mkdocs模板 依存关系 1- 2- 安装 然后只需下载下面的mkdocs-rtl项目并运行mkdocs serve命令。 git clone https://github.com/mberneti/mkdocs-rtl.git cd mkdocs-rtl mkdocs serve +该项目带有自定义的模板版本1和版本2。 客制化 要自定义文档格式，只需编辑主题文件夹文件。 出示文件 要生成文档，可以使用mkdocs build命令，该命令执行最终的html文件以将文档发布到docs文件夹中。 感谢Sabre Rasti Kardar提供了此模板中使用的。
foam-mkdocs-template:使用mkdocs mkdocs-material mkdocs-roamlinks-plugin
05-19
泡沫/黑曜石-mkdocs-template 以简单直观的方式分享您的泡沫/黑曜石/降价笔记！ 支持[[roamlike链接]] 该模板使用 ， ， 和许多mkdocs插件。 演示版 国内访问 用法：部署到github页面 分叉此存储库 将您的文档添加...
mkdocs-mermaid2-plugin:适用于mkdocs的美人鱼图插件
05-10
mkdocs-mermaid2-plugin 一个插件，可将文本图形描述呈现为图形（流程图，顺序图，饼图等）。 这是来自的叉子，该不再维护。 它提供了扩展的文档以及新功能。 用法 一般原则 如何编写美人鱼图 向Mermaid引擎添加...
探索知识的港湾 —— 使用MKDocs打造的互动式技术指南
gitblog_00082的博客
06-07 394
探索知识的港湾 —— 使用MKDocs打造的互动式技术指南 项目地址:https://gitcode.com/xsltdev/reactdev.ru 在浩瀚的技术海洋中，拥有一份详尽且易用的知识指南如同航海中的灯塔，为开发者们指引方向。今天，我们要推荐的开源项目正是一座这样的灯塔——一个基于Markdown与MKDocs精心构建的技术参考手册。 项目介绍 这个项目是一个技术指南的典范，它采用流行的...
mkdocs如何使用mkdocs-login添加身份验证功能
04-24
要使用mkdocs-login添加身份验证功能，您需要先安装mkdocs和mkdocs-login插件。然后，您可以编辑您的mkdocs.yml文件并添加以下配置： ``` plugins: - search - mkdocs-login ``` 接下来，您需要在您的mkdocs.yml文件中设置访问控制规则。您可以配置哪些页面需要身份验证以及哪些用户可以访问这些页面。例如： ``` login: enabled: true provider: yaml provider_args: file: users.yaml redirect: /secure/ nav: - Home: index.md - Secure: secure/index.md login: true groups: ['admin', 'editor'] ``` 其中，users.yaml指定了用户列表和其所属的群组。在此示例中，“Secure”页面需要验证访问，只有属于“admin”或“editor”组的用户才能访问。 最后，您需要运行mkdocs serve命令以启动您的文档网站。您将看到一个新的登录页面，并且您的用户必须在此页面上登录才能访问受保护的页面。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Wcowin

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值