Bitbucket README, упорядоченный список, перезапускается после блока кода

Я использую Markdown для моего README.md в Bitbucket и понимаю, что мой упорядоченный перезапуск списка до 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 являются как 1. в моем README, чего я не хочу. Может быть, я должен использовать `` вместо этого? Результат не будет одного и того же стиля, но если в моем списке будет нумерация, это будет по крайней мере лучше.

Любые решения?

Ответы

Ответ 1

Вставьте 4 пробела перед блоками >. Это служит сразу двум целям: во-первых, он отбрасывает цитату, поэтому он выравнивается с номером над ним (поскольку он является частью этого пронумерованного элемента). Во-вторых, большинство парсеров MD знают, что это означает, что элемент с отступом не должен прерывать нумерованный список.

На самом деле, я думаю, вы ошибаетесь, чтобы использовать "цитату блока". Возможно, вы должны использовать обычный "отступ" с отступом здесь, используя 4 пробела и обратные ссылки вокруг вашего буквального кода:

  • Клонировать хранилище

    git clone URL

(Четыре пробела и `вокруг командной строки.)

Ответ 2

Еще лучший ответ, общая структура должна быть такой:

1. item n.1
2. item n.2

        #!json
        {
            "key": "value"
        }

3. item n.3

Итак:

  1. Поставьте пустую строку до и после блока кода.
  2. Сделать отступ для всего 8 пробелов; нет необходимости в 3 кавычки до и после блока кода.
  3. Если вы хотите выделить синтаксис, поместите #!<language-name> с отступом в 8 пробелов перед блоком кода.

Bitbucket будет соблюдать нумерацию списка, и вы не потеряете подсветку синтаксиса.

Ответ 3

Просто, чтобы суммировать комментарии выше для пользователей, сталкивающихся с этой проблемой на BitBucket, здесь фрагмент кода, который я использую шаблон README.md для моих проектов nodejs/express, который работает:

**Instructions**

1. Clone the git repo from BitBucket

    '''
    cd *Install_Directory*
    git clone https://[email protected]/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/

А для полноты здесь вывод с использованием анализатора разметки Qaru:

Инструкции

  1. Клонировать репозиторий Git из BitBucket

    cd *Install_Directory*
git clone https://[email protected]/user/repo.git

  2. Установите/обновите необходимые модули npm

     npm update

  3. Запуск

    node server.js
(or)
nodemon

  4. Посмотреть панель отслеживания, посетив http://localhost:9988/