【问题标题】:Bitbucket README markdown ordered list restarts after code blockBitbucket README markdown 有序列表在代码块后重新启动
【发布时间】:2013-11-26 14:22:59
【问题描述】:

我在 Bitbucket 上为我的 README.md 使用 Markdown,并在代码块后实现我的有序列表重新启动到 1。这是我的文字示例:

1. Download VirtualBox
2. Download Vagrant
3. Clone the repository

> git clone URL

4. Go to repository folder

> cd /my_repo

5. Setup your dev environment

数字 4 和 5 在我的 README 中都是 1.,这不是我想要的。也许我应该使用 `` 代替?结果不会是相同的样式,但如果我的列表保留编号至少会更好。

有什么解决办法吗?

【问题讨论】:

    标签: markdown bitbucket


    【解决方案1】:

    在块引用 > 之前插入 4 个空格。这同时有两个目的:首先,它缩进引号,因此它与上面的数字对齐(因为它该编号项目的一部分)。其次,大多数 MD 解析器都知道这意味着缩进的项目不应该打断编号列表。

    实际上,我认为您使用“块引用”是错误的。也许您应该在此处使用 regular 缩进的“代码”,在文字代码周围使用 4 个空格和反引号:

    1. 克隆存储库

      git clone URL

    (命令行周围有四个空格和`。)

    【讨论】:

    • 那就更好了。首先它会被正确格式化为代码,然后列表不会被打断,谢谢@Jongware!
    • 当在列表中缩进使用时,这似乎不适用于跨越多行的代码。如果可以的话,有什么想法吗?
    • 在列表项下添加一段代码,每个嵌套级别缩进4个空格或制表符(嵌套在列表项下),然后再缩进4个空格或制表符(表示代码块) .换句话说,要将代码块嵌套在第一级列表项下,请在每行键入 8 个前导空格的代码。您还需要在代码块之前和之后有一个空行。您不需要代码周围的反引号字符。
    • @TravisG。但是你失去了代码高亮,对吧?我想保留它!
    【解决方案2】:

    一个更好的答案,一般结构应该是这样的:

    1. item n.1
    2. item n.2
    
            #!json
            {
                "key": "value"
            }
    
    3. item n.3
    

    所以:

    1. 在您的代码块前后各空一行。
    2. 缩进8个空格;无需在代码块前后加 3 个反引号。
    3. 如果您想要语法高亮显示,请在代码块前添加一个缩进为 8 个空格的 #!<language-name>

    Bitbucket 将尊重列表编号,您不会丢失语法突出显示。

    【讨论】:

      【解决方案3】:

      只是为在 BitBucket 上遇到此问题的用户总结上面的 cmets,这里有一段代码,我使用 README.md 样板来运行我的 nodejs/express 项目:

      **Instructions**
      
      1. Clone the git repo from BitBucket
      
          ```
          cd *Install_Directory*
          git clone https://user@bitbucket.org/user/repo.git
           ```
      
      2. Install/upgrade required npm modules
      
          ```
           npm update
           ```
      
      3. Run
      
          ```
          node server.js
          (or)
          nodemon
          ```
      
      4. View tracking dashboard by visiting http://localhost:9988/
      

      为了完整起见,这里是使用 StackOverflow 的 markdown 解析器的输出:

      说明

      1. 从 BitBucket 克隆 git 仓库

        cd *Install_Directory*
        git clone https://user@bitbucket.org/user/repo.git
        
      2. 安装/升级所需的 npm 模块

         npm update
        
      3. 运行

        node server.js
        (or)
        nodemon
        
      4. 通过访问http://localhost:9988/查看跟踪仪表板

      【讨论】:

        【解决方案4】:

        要扩展@Willian's 解决方案,请尝试将代码缩进 8 个空格,这似乎启用了 basic 块突出显示,而不是代码语法。此外,如果您在代码之前嵌套了一些项目符号,它将不起作用。就像在代码之前的 #3 下嵌套了几个项目符号一样。

        1. First item
        2. Second Item
        3. Some code example:  
        
                var a = "Some string";
                function test() {
                    return a + "/n";
                }
        
        4. Forth item
        

        【讨论】:

          猜你喜欢
          • 2018-09-17
          • 2023-04-02
          • 1970-01-01
          • 1970-01-01
          • 1970-01-01
          • 1970-01-01
          • 1970-01-01
          • 2019-10-16
          • 1970-01-01
          相关资源
          最近更新 更多