Продолжение нумерованного списка Пикша
Как продолжить нумерованный список с помощью инструмента документации пикши? Следующие строки в пикше
-- 1. First line.
--
-- 2. Second line with instructions to do something
--
-- >>> command-linecmd param
--
-- 3. Third line..
--
сгенерировать следующий HTML:
</p><ol><li> First line.
</li><li> Second line with instructions to do something
</li></ol><pre class="screen"><code class="prompt">>>> </code><strong class="userinput"><code>command-linecmd param
</code></strong></pre><ol><li> Third line..
</li></ol>
Это нарушает нумерацию. Есть ли способ заставить пикшу продолжать работу с третьим номером также в HTML, или я должен попробовать что-то другое (>>> дает хорошее форматирование, почему я хотел бы использовать его)?
1 ответ
Ты не можешь Вы используете >>>
, Чтобы это выглядело в качестве примера, оно должно быть в начале абзаца.
Что считается началом абзаца?
Что-нибудь в начале комментария Хэддока, пропуская любой пробел, предшествующий этому.
Что-нибудь после пустой строки.
В вашем сценарии у вас есть 4 абзаца: элемент списка, элемент списка, пример, элемент списка. Внутри Хэддок полностью игнорирует список номеров, которые вы записываете: вы можете начать с 999, если хотите. Когда Хэддок видит последовательные абзацы с одним и тем же типом списка, он объединяет их и нумерует их. Поскольку вы нарушаете шаблон, списки не рассматриваются как продолжение. Отступ >>>
с пробелами в этом сценарии фактически нет смысла, так как они будут удалены, поскольку мы в новом параграфе. Обратите внимание, что пробелы важны, если у вас есть последовательные примеры: вы можете поместить их в один и тот же абзац, если ваши отступы идентичны.
Другие вещи, которые должны быть в их собственном абзаце (и, следовательно, нарушать порядок списков), это списки, треки для птиц, кодовые блоки (абзац, содержащий только текст между @
s) и свойства (prop>
).
Хотя это можно решить, разрешив вложение абзацев, это не планируется. Билет № 27 предназначен исключительно для вложенных списков (которые действительно являются сущностями уровня абзаца), но не решит эту проблему.
Я рекомендую вам использовать неупорядоченные списки, если числа не являются жизненно важными или обмануть немного и использовать именованные списки ([name] content
)
РЕДАКТИРОВАТЬ: По состоянию на 12 января 2014 года билет Haddock № 27 был разрешен, и теперь это возможно, если сделать отступы в примере 4 после второго элемента списка. Это:
1. First element
2. Second element
>>> your example
your example result
3. Third element
Теперь результаты в: