foliant icon indicating copy to clipboard operation
foliant copied to clipboard

Code & list formatting in the readme

Open NickVolynkin opened this issue 5 years ago • 1 comments

  • Make code examples a part of list items. Before now, they were outside of the ordered list structure.

  • Use console as the lexer for code examples having both command and output lines. See https://pygments.org/docs/lexers/#pygments.lexers.shell.BashSessionLexer

NickVolynkin avatar Nov 27 '20 06:11 NickVolynkin

@NickVolynkin Thanks for the PR!

Make code examples a part of list items. Before now, they were outside of the ordered list structure.

Unfortunately, this won't work due to MkDocs limitations: https://foliant-docs.github.io/docs/backends/mkdocs/#fenced-code-is-not-rendered-in-list-items-or-blockquotes

Please revert this change.

moigagoo avatar Nov 27 '20 07:11 moigagoo