温馨提示:本文翻译自stackoverflow.com，查看原文请点击：magento - Code Formatting for the ReadTheDocs System

magento python-sphinx read-the-docs mkdocs

magento - ReadTheDocs系统的代码格式

发布于 2020-03-27 11:42:31

我是第一次使用“ 阅读文档 ”。我正在为命令行系统编写文档，而我的“代码示例”包括shell输出的日志。Shell输出最终看起来像这样

就是说-服务（或我对它的使用？）正在尝试格式化运行shell命令的示例，就好像它是源代码一样，并且正在将其magento2:generate视为类常量。

我可以控制哪些代码块在阅读文档时获取源代码格式吗？我试过在管理员中未设置任何基本语言，但似乎没有效果。还是我需要在Sphinx级别的mkdocs上控制这些东西？（通过将markdown或sphinx文件转换为漂亮的HTML文件来阅读文档，可以看到其他内容吗？还是我不走运？

提问者

Alan Storm

被浏览

64

查看英文版

查看原文

Waylan 2019-07-10 02:28

您需要在源文档中定义代码块的“语言”。Sphinx和MkDocs都将尝试猜测该语言，这通常已经足够好了。但是，有时它会猜错并导致奇怪的突出显示。为了避免这种情况，这两种实现都提供了一种机制来手动定义每个代码块的语言。

狮身人面像

对于Sphinx，可以使用code-block指令并包括该块的“语言”：

.. code-block:: console

    You shell commands go here

在上面的示例中，我使用console了shell会话。别名shell-session也可以使用。需要注意的是替代词法分析器bash（和它的别名：sh，ksh，zsh，和shell），因为它们是一个shell脚本woudl不严格是合适的，而你在一个shell会话同时显示的命令和theoutput。

在Pygments文档中可以找到受支持的语言代码的完整列表。

MkDocs

MkDocs利用Fenced 代码块 Markdown扩展来定义代码块的“语言”：

``` shell
Your shell commands go here
```

作为MkDocs使用highlight.js而非Pygments来做，支持的语言列表是不同的。因此，我shell在上面的示例中使用了（用于shell会话）。

最新帖子

1

“上火”用英语应该怎么翻译比较好呢？

2

程序员年龄真的很重要吗

3

有没有一个轻量的 Docker+Caddy/Nginx 的服务器面板？

4

请教： GO 编译器是如何判断某变量声明但未被使用的？

5

各位彦祖们，请问在 macos 中如何使用 ctrl+insert 复制 && shift+insert 粘贴呢

6

求教如何爬取油管评论呢？

7

PC 和小程序的后台接口要分离吗

8

火绒的杀毒，比 win10 自带的要好么？可是，我只想要火绒的网络进程监控和控制，怎么办？

9

后端接口如何做版本控制？

10

苹果 M1 mba 自带的 USB-C 充电线是没有数据传输视频信号能力的， Only 充电。

最新文章

1

Angular - ngx-center 单运行时多项目共享依赖解决方案

2

一个为博客文章/论文/数据提供版权登记的工具，欢迎大家试用

3

自建 Gravatar 国内+全球镜像加速服务

4

追踪 Windows 10 鼠标旁边一个有一个漏斗在闪的原因和解决方法

5

程序员研发质量与效率的绩效指标设计

6

带你彻底搞懂什么是 DevOps

7

[开源] BlackDex，无需环境， Android 新姿势脱壳工具

8

如何在windows系统的bat批命令脚本里激活python3 venv虚拟环境

9

Python 代码安全指南

10

Java 代码安全指南.

相关问题

1

Magento：根据客户群获取产品价格

2

取消订单后重置库存状态

3

贷项通知单“返回库存”不更新库存可用性

4

通过数据库查询（EAV）获取产品报告

5

Python Selenium：未正确验证Block-Title。

6

安装magento 2不会部署/ pub / static / frontend和backend

7

Magento 2.3.4在我的本地主机中无法正常工作

8

magento 2中的重写模板

9

从其他jsTree实例保护jsTree样式

10

如何在magento 2.0中添加/插入扩展？