Question

我有以下标记代码段，它将在Github上显示：

1. Ask a supervisor for a `cmprod.pem` file and move it into the `~/.ssh` folder.
2. Run `chmod 600 ~/.ssh/cmprod.pem`
3. Run `eb ssh` and type `yes` when it asks if you would like to add the key to your keychain.
4. Once connected via SSH, to access the application's source code, perform the following steps
    - `sudo docker ps`
    - Copy the desired value from the `CONTAINER ID` column
    - Run `sudo docker exec -it $CONTAINER_ID rails c` using the copied value.

问题是嵌套列表（步骤4中的三个要点）未正确格式化。他们最终看起来像这样：

向主管询问cmprod.pem文件并将其移至~/.ssh文件夹。
运行chmod 600 ~/.ssh/cmprod.pem
运行eb ssh并在询问您是否要将密钥添加到钥匙串时输入yes。
通过SSH连接后，要访问应用程序的源代码，请执行以下步骤 - sudo docker ps - 从CONTAINER ID列复制所需的值
- 使用复制的值运行sudo docker exec -it $CONTAINER_ID rails c。

Answer 1

这取决于您使用的规则集。根据{{3}}，GitHub使用（我假设这里由于[github]标签而相关），“列表可以中断段落。也就是说，不需要空行来分隔段落以下列表。“此版本的Commonmark甚至显示了与您类似的示例。如果它不适合使用Commonmark解析器，那么这将是一个错误。

但是，如果您不使用Commonmark（或作为任何Commonmark错误的解决方法），则Markdown规则要求您在列表和前一段之间有一个空行。由于父列表的第4项中的文本将是一个段落（在列表项内），因此该段落和段落后面的子列表项之间需要有一个空行。像这样：

1. Ask a supervisor for a `cmprod.pem` file and move it into the `~/.ssh` folder.
2. Run `chmod 600 ~/.ssh/cmprod.pem`
3. Run `eb ssh` and type `yes` when it asks if you would like to add the key to your keychain.
4. Once connected via SSH, to access the application's source code, perform the following steps

    - `sudo docker ps`
    - Copy the desired value from the `CONTAINER ID` column
    - Run `sudo docker exec -it $CONTAINER_ID rails c` using the copied value.

有必要记住，在嵌套列表项时，您需要遵循列表之外的所有相同规则。然后只缩进一个级别。因此，例如，嵌套在第4项中的所有内容在列表项之外都是这样的：

Once connected via SSH, to access the application's source code, perform the following steps

- `sudo docker ps`
- Copy the desired value from the `CONTAINER ID` column
- Run `sudo docker exec -it $CONTAINER_ID rails c` using the copied value.

段落和列表之间需要一个空行。因此，在将所有内容嵌套到列表中时，需要保持相同的格式并保持空白行。仅仅因为第一行在子弹（或列表编号）之后开始并不意味着它不遵循相同的规则。

最后，即使您使用的是Commonmark解析器，我也建议使用空白行。这是任何Markdown linter建议的好形式。

嵌套列表格式不正确

1 个答案: