问题标签 [mkdocs]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
1178 浏览

python - 如何在没有服务器的本地计算机上使用 Mkdocs?

我安装了 Mkdocs (Python 3.6.5) 并编辑和构建了 Markdown 文件。

我尝试使用浏览器打开主 index.html 文件,但无法直接打开链接到其他 HTML 文件的 HTML 页面。

使用命令提示符并输入“mkdocs serve”,我可以打开链接页面。我知道这是没有服务器的 Mkdocs 的正常功能。

我可以只在本地计算机上使用 Mkdocs 吗?

0 投票
1 回答
226 浏览

gcloud - gcloud storage mkdocs 和 index.html 不太好用

我在谷歌云存储上托管一个由mkdocs. 但是,我遇到的错误不应该与这个库相关。

我已设置权限,可以在以下位置查看该站点

这很好,但它无法打开此网址:

它不承认它应该抓取index.html文件。

这对于索引页面来说不是什么大问题(我可以将用户指向该页面),但对于网站上的所有其他链接来说却是一个大问题。有一个使用此结构生成的子文件夹:

歌存储文档分享了一些可能发生的事情。但即使应用了他们的建议,它也不起作用。

所以我正在寻找解决方案。我的想法是:

  1. 也许GCloud不喜欢我没有自己的域名这一事实。这应该很重要,但可能无济于事。
  2. 也许 mkdocs 中有一个设置,因此并非所有内容都是通过index.html.
  3. 不为此使用 GCloud 存储,而是使用 github/gitlab 页面或其他东西来托管此静态站点。

任何帮助深表感谢。

0 投票
0 回答
1083 浏览

url - MkDocs 无法与自定义 URL 路径一起正常工作

目前我正在使用mkdocs, version 1.0.3 from /usr/local/lib/python2.7/dist-packages/mkdocs (Python 2.7) Withmkdocs-material-3.0.4主题。

我使用命令生成了一个静态站点mkdocs build并尝试部署它。生成所有站点文件并使用静态内容的相对路径(例如。js/something.js)。

问题是我需要从 URL 使用它https://internal.domain.com/docs/。但我找不到配置来指定相对路径以生成带前缀的路径(例如。docs/js/something.js)。

在服务器端,我使用带有重写规则的 k8s + ingress(从https://internal.domain.com/docs/到` https://docs_service/)。

关于如何修复它的任何建议?

0 投票
2 回答
396 浏览

javascript - 使用 JavaScript (Netlify Identity) 控制内容:内容在慢速连接中闪烁,如何仅在登录检查后加载?

我并不是真正的网络应用程序开发人员,我想询问有关控制网站内容的最佳做法。

我正准备部署使用 mkdocs 创建的文档。它使用 Netlify Identity,因为 Github 身份验证无需任何编码即可使用。

我当前的解决方案:我在 head 中添加了 Netlify Identity 脚本,并通过 mkdocs 中的模板插件添加了登录/注销按钮,然后创建了一个静态文档 /login/ (在 mkdocs 中自动获取但不使用模板生成) .

在标准模板中有一个 JS 重定向到 /login/ 除非用户登录:

在静态页面上,只有在用户登录后才会重定向到 /:

我希望这是一个合理的方法。文档不存储任何重要内容,但我仍然不希望该内容暴露。

但我注意到在慢速连接时重定向需要一两秒钟,因此当访问深层 URL 时,登录前内容会在屏幕上闪烁。

只有在执行登录检查后才能停止此操作并加载内容?

0 投票
1 回答
453 浏览

javascript - 带有 mkdocs 的本地 mathjax

我想在无法访问互联网的计算机上将 MathJax 与 Mkdocs 一起使用,因此我不能只调用 Mathjax CDN。

配置

mkdocs.yml

文件结构

根据Mathjax 的文档,该文件夹/MathJax-2.7.5/包含整个未压缩的存档。

问题

运行mkdocs serve我得到以下错误:

这两个错误重复发生,直到我停止服务器。


使用--no-livereload防止问题,服务器返回:

但数学不呈现:

未呈现数学

0 投票
1 回答
232 浏览

cors - 在 mkdocs 本地构建中允许 CORS(加载失败跨源请求仅支持方案 http、data、chrome、chrome-extension、https)

我在使用本地构建 mkdocs 时遇到font-awesome了一个问题。我理解这个问题以及它为什么不起作用,但我试图在本地分发我的文档而不是使用网络服务器,这就是为什么我必须依赖而不是. 有没有绕过这个?search_index.jsonmkdocs buildfile://http

我在最新的 Chrome 和 Firefox 上得到了相同的结果。

实际问题是Failed to load file:///Users/securisec/guide/site/search/search_index.json: Cross origin requests are only supported for protocol schemes: http, data, chrome, chrome-extension, https。我明白。想知道在使用 file:// 时是否有 mkdocs 配置选项允许这样做。根据他们的文档,我找不到设置附加标题的地方

0 投票
1 回答
259 浏览

mkdocs - Mkdocs 站点打开不正确

我的mkdocs.yml文件看起来像:

当我打开它时,网址是这样的:http://10.2.0.8/blabla/master/Navigation.md并且不起作用,我得到404 Not Found nginx/1.14.0 (Ubuntu)错误。.md如果我在 url 的末尾删除它可以正常工作。

但是,在本地打开它就像http://127.0.0.1:8000/Navigation/ 有人知道这有什么问题吗?

0 投票
0 回答
44 浏览

javascript - 填写外部站点的登录详细信息

我有一个带角度的应用程序,我有一个输入:

调用方法:

this.documentationUrl拥有文档(比如说 docs.com)网站的链接,并且是用Mkdocs. 单击时,会弹出警报,询问用户名和密码。是否可以填写弹出的警报?应该在angularMkdocs上完成哪一侧?我知道这应该是可能的,但我不知道如何以及从哪里开始。

我试过获取html内容:

但是我得到:401 Authorization Required nginx/1.14.0 (Ubuntu)。如果我手动转到网站警报会弹出,但现在我没有在响应中得到它。

我也试过<iframe id="iframe" src="https://docs.com/"></iframe>

但这似乎也没有得到警报

0 投票
1 回答
484 浏览

css - 阅读文档上的图像大小(小图像宽度)

我正在使用MkDocs使用 Markdown 生成文档,主题为 Read the Docs。

但是,我无法通过在手机上放大来获取小图像。

我认为这与 Read the Docs CSS 有关,但我无法理解我应该如何覆盖width:100%小屏幕上的设置行为。

应用于大屏幕上的某个图像的 CSS(使用 chrome 检查)是:

但是如果我缩小屏幕,我会得到这个额外的 CSS:

我可以手动设置图像大小,例如:

但如果我可以创建一些 CSS 以确保将其应用于所有图像,我更愿意,这样我就不必在每次想要添加小图像时在 Markdown 文件的中间添加这个 HTML 标记。

0 投票
2 回答
45 浏览

web - 网络上许多技术文档使用的 web-template 是什么?

我发现以下网站具有相似的风格(或主题或模板):

看起来许多技术文档网站都使用这种风格(或模板)。

我的问题是: 那是什么样的模板?

以及如何在我的技术博客中使用它?