了解过Traefik,nginx-ingress的同学都知道他们的官方文档都是基于mkdocs和material主题制作而成,你觉得这种文档库怎么样?有没有心动把自己的文档也整成那样的?,下面我们直接动手干起来吧。
MkDocs---markdown项目文档工具,是一个用来创建项目文档的快速、简单、完美的静态站点生成器,文档源码使用Markdown来撰写,用一个yml文件作为配置文档。它具有如下几个优点:
Mkdocs 是一个采用 Python 构建轻量级的静态 HTML 在线文档框架,内置部署到 Github Pages 的功能。我用来创建实践指南,用来做个人的知识积累。
MkDocs 是一个快速、简单、快捷可用的静态网站生成工具,文档使用 Markdown 书写,并仅需一个 YAML 配置文件。静态页面生成工具有 Docsify, VurPress, GitBook, hexo, Hugo 等等。本人使用过 Hexo和 Docsify,直到我发现了 MkDocs 以及它的绝配主题 mkdocs-material ,Mkdocs 的目录下仅需一个配置文件,然后就是完全的 MakeDown 文件即可,没有其他多余的配置,深得我心。今天就来讲讲如何为它配置一下 GitLabPipline 实现自动生成并提交到 GitLabPages。
GiantPandaCV 一直是以公众号的形式和大家见面,但现在随着分享干货的日益增多,我们不满足于公众号小小的窗口,为了方便大家快速检索自己感兴趣的知识,也为了增加和大家的交流, GiantPandaCV.COM 应运而生,拉到底部点击 阅读原文 即可访问,或者复制网址到浏览器访问。
对于程序员来说,写技术文档是一项必备的技能。由于GitHub和Markdown格式的普及,很多时候我们可以用markdown来简便地写出技术文档,并且 通过GitHub Pages等工具快速地进行技术文档的部署。
MkDocs是一个快速,简单且彻头彻尾的华丽静态站点生成器,旨在构建项目文档。文档源文件以Markdown编写,并使用单个YAML配置文件进行配置。
MkDocs 是快速,简单和华丽的静态网站生成器,可以构建项目文档。文档源文件在 Markdown 编写,使用单个 YAML 配置文件配置。
在使用Mkdocs之前,需要先安装Mkdocs。Mkdocs可以使用Python的包管理工具pip进行安装,具体步骤如下:
同博客框架 WordPress、Hexo 等一样,Web 文档也有自己的框架,如比如 Java 的 Javadoc,Python 的 pydoc,以及Python-sphinx。对于 Python 有专门文档标记语言 reStructuredText(RST),常见的 Python 各种库和工具的帮助文档基本都是用 RST 所写。如 Requests、Flask、Scrapy 等。
Mkdocs 是我比较喜欢的文档系统,用于部署知识库是非常合适的,特别是Mkdocs+material组合更是我最为喜欢的。 目前唯一的缺点就是中文搜索方面不足,所有需要手动修改一下,当然如果您和我一样基于Docker部署,那么也可以修改一次到处运行。
通过文档介绍这些信息,新读者才能更直观地了解产品,决定是否要用它,而产品的用户则能更顺利地使用它。
mkdocs 是一个基于Python 对 Markdown 非常友好的文档生成器,中文文档地址
MkDocs是一个基于Python的静态站点生成器,它可以将Markdown格式的文档转换为漂亮的静态网站。MkDocs提供了一种简单而灵活的方式来创建文档,并支持多种主题和插件。
最近啊,我比较迷恋文档和静态站点生成,今天我们再分享一个基于 Python 和 Markdown 的文档生成器。它就是 MkDocs。
10个优秀的程序员里,有9个人都有写博客的习惯。这是非常好的习惯,它使得知识得以提炼,转输出为输入,在提升自己的同时,还能利用互联网易传播的特性,将知识分享给每一个热爱学习的人。这是值得每个程序员,投入时间和精力去坚持做下去的事。
前面我们介绍过 MKDocs 的基础用法(MKDocs 入门)。很多同学都表示非常香,但是默认的主题不够美观,虽然我们可以通过内置的 readthedocs 主题来改善,但是还不够美,几天我们就一起来尝试一款比较现代的 MKDocs 主题 material。
由于将 HAUE-CS-WIKI 部署到了我自己的服务器上作为国内镜像站,每次在源站更新后都需要手动拉取镜像站的更新实在是太麻烦了,因此产生了编写该脚本的需求(
这些开源项目旨在为用户提供一种简单而强大的方式来构建现代化文档或静态网站。它们拥有一些关键特性:简洁易用、支持使用Markdown编写内容、提供多种主题选择和插件扩展能力。这些工具可以帮助您方便快捷地生成高质量的文档,并且轻松进行团队协作和社区分享。如果您正在寻找一个功能强大又易于上手的工具来构建静态网站或在线文档,请考虑尝试其中之一。
相信很多人都想要搭建一个自己的博客或是给项目做文档网站。本文将要推荐的静态网站生成器(Static Site Generator, SSG),它做的事情就是把你的文档、内容(通常为 Markdown 文件)生成可发布成网站(html)的工具,这样你就可以专心创作,同时也有了一块自己发表自己想法的网站。然后 GitHub、Gitee 等均支持免费 Page 服务,通过简单的配置 SSG 就可以实现一条命令发布,有一个自己小窝就是这么简单和方便~
不排除很多小伙伴,从小认识电脑,就开始装office全家桶。有什么重要的小笔记,小心心地写在小本本上,用了电脑,写一个word存档。
我们一般如何处理软件的运行环境问题?一般上,即使用docker,我们的python脚本还是不可避免地需要安装额外的库。而每添加一个库都制作一个新的docker,这会是一个灾难。有必要寻找一种更优雅的解决方案。
VS Code有很多选项可以来配置编辑器,你可以通过用户设置来设置全局选项,或在工作空间设置中针对每个文件夹或项目设置,选项设置保存在settings.json 文件中。
Microsoft PowerToys 是一套用于调整和优化 Windows 体验以提高生产力的实用工具集。该项目包含多个功能模块,其中主要功能有:Always on Top、FancyZones、File Explorer Add-ons 等。其核心优势和关键特点包括:
OpenMMLab 框架几乎全面覆盖了深度学习视觉任务的方方面面。针对每一个具体的任务,我们都提供了一个相应的算法库,如用于分类任务的 MMClassification,用于检测任务的 MMDetection 和用于分割任务的 MMSegmentation 等等。
安装Anaconda,就已经自动jupyter notebook,没有的话自己从新安装。
root 用户可以运行pip install mkdocs 但gitlab-runner 运行pip install mkdocs 则下列错误
当时我学习Deep Learning已有两个月,看了很多论文、教程与博客,于是尝试着去阅读Keras的源代码来学习别人是怎么实现的,尤其是back propagation这一块。
首先,我们需要Docker。毕竟我们的重点并不是在安装配置spark上面,怎么简便,怎么做是最好的啦。不过为了适用尽量多的场景,我们会配置一个单机集群,同时配置Pycharm远程调试。
使用pycharm时, pycharm会自动把我们新建的每个项目都加入到sys.path路径中, 我们在使用过程中根本不涉及项目路径的处理, 但是当项目部署到linux上时, 问题就来了, linux上可没有pycharm来帮我们处理路径. 解决如下:
优点:简单快捷 缺点:治标不治本,每次写一个新的Application都要加载一遍findspark
注意事项:需要注意的是, sqlite安装完成之后需要进行重新编译python, 需要注意的是,sqlite安装完成之后需要进行重新编译python 1.下载并源码编译python3 #wget https://www.python.org/ftp/python/3.4.5/Python-3.4.5.tar.xz # xz -d Python-3.4.5.tar.xz # tar xf Python-3.4.5.tar -C /usr/local/src/ # cd /usr/local/src/Pytho
pycharm 是一款针对python开发的优秀的IDE, 以下是针对其在mac上的开发配置使用
新冠肺炎期间,约翰霍普金斯大学开发的疫情地图网站单日 PV 达 10 亿次,查看源代码可以看出它是一个单页应用(single-page application,缩写 SPA),JS 调用后端 API 返回动态数据。
官方链接在这里。这里我没有下载整个models,在linux下面只下载了Object_Detection。方法如下:
我在修改 ctf-wiki 目录后进行 mkdocs build 去生成索引目录的时候报错:
支撑10亿PV的云存储 新冠肺炎期间,约翰霍普金斯大学开发的疫情地图网站单日PV达10亿次,查看源代码可以看出它是一个单页应用(single-page application,缩写SPA),JS调用后端API返回动态数据。那么,部署一个10亿PV的静态网站需要购买几台服务器呢? 答案是:0台! 在云计算时代,静态网站已不再需要服务器,部署到云存储,开启CDN即可全球高速访问。 静态网站架构发展史 1991年,万维网诞生,包括3项关键技术: 统一资源标志符(URI)、HTML、HTTP。
最近把我的博客换成了新版本主题 Congo,并采用了 Github Action 发布我的博客,以下是迁移步骤:
之前对mac os系统自带的python进行了升级,结果发现新安装的python的site-packages目录并没有加到python的系统路径中,所以在使用其他库时发现出现了缺少模块的错误。
VS code 是微软的轻量级但功能强大的IDE,刚刚配置好anaconda python环境时可能出现不打印print内容的问题,本文记录该问题解决方法。 问题复现 刚刚安装好VS code 与 Anaconda时,hello world程序不在终端显示打印内容: 📷 不显示打印内容。 问题分析 故障原因在于命令中默认使用的是 anaconda 的pythonw.exe命令,将其换为python.exe即可。 修改方法 文件-首选项-设置-打开设置: 📷 修改"python.pythonPat
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_25737169/article/details/77773884
newrelic-admin 命令调用的是 newrelic.admin:main,这是代码的入口。首先看一下 newrelic/admin/目录。
Python:https://www.python.org/ftp/python/3.7.0/python-3.7.0-amd64.exe
年关将至,大家都在忙着为项目贡献代码。12月初,GitHub官方在开源项目中挑选了下述顶级热门项目作为11月的优秀项目。
在Alphabet大额资金支持下,DeepMind一直以实现AGI为为目标的公司在各个领域不断的尝试,做出了很多基础研究。其中最为出名的当属在强化学习方面的探索,从2013年的Atari游戏到AlphaGo的横空出世,再到终极AlphaZero的实现,完成了一次次巨大的挑战,但一个完善的环境对强化学习的发展来说是非常重要的,而DeepMind就拥有这样一个杀手锏。
首先请大家确定VsCode的安装以及Python环境的配置安装已经完毕!如未完成请参考博主以前的文章。
--help: --insecure Allows serving static files even if DEBUG is False.
本文将介绍最流行的十大博客静态站点生成工具,以 Github star 数来排名。
如果想正确显示 mapbox 地图,需要注册mapbox[1],并在 superset 里配置 MAPBOX_API_KEY
领取专属 10元无门槛券
手把手带您无忧上云