magento ReadTheDocs系统的代码格式

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会话）。

热门github

Build Real-Time Knowledge Graphs for AI Agents

21 Lessons, Get Started Building with Generative AI 🔗 https://microsoft.github.io/generative-ai-for-beginners/ (翻译：12 节课程，开始使用生成式 AI 进行构建)

AI-powered multi-agent builder

Linux, Jenkins, AWS, SRE, Prometheus, Docker, Python, Ansible, Git, Kubernetes, Terraform, OpenStack, SQL, NoSQL, Azure, GCP, DNS, Elastic, Network, Virtualization. DevOps Interview Questions (翻译：包含Linux、Jenkins、AWS、SRE、Prometheus、Docker、Python、Ansible、Git、Kubernetes、Terraform、OpenStack、SQL、NoSQL、Azure、GCP、DNS、弹性、网络、虚拟化等DevOps 面试问题)

#1 Locally hosted web application that allows you to perform various operations on PDF files

Burn is a next generation Deep Learning Framework that doesn't compromise on flexibility, efficiency and portability.

A collection of inspiring lists, manuals, cheatsheets, blogs, hacks, one-liners, cli/web tools and more. (翻译：这个存储库是我每天在工作中使用的各种材料和工具的集合。)

ChatGPT DAN, Jailbreaks prompt

Master programming by recreating your favorite technologies from scratch. (翻译：在这个项目中，你能学会如何创造自己的各种工具，引擎，游戏，框架，库......)

Agent S: an open agentic framework that uses computers like a human

A GUI client for Windows, Linux and macOS, support Xray and sing-box and others (翻译：一个 V2Ray 的 Windows 客户端，支持 Xray 核心和 v2fly 核心)

Lightning-fast and Powerful Code Editor written in Rust (翻译：使用Rust编写的快速、强大的代码编辑器)

Claude can perform Web Search | Exa with MCP (Model Context Protocol)

Your AI second brain. Self-hostable. Get answers from the web or your docs. Build custom agents, schedule automations, do deep research. Turn any online or local LLM into your personal, autonomous AI (gpt, claude, gemini, llama, qwen, mistral). Get started - free.

AeroSpace is an i3-like tiling window manager for macOS

magento - ReadTheDocs系统的代码格式

狮身人面像

MkDocs

相关问题

热门github