Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code & list formatting in the readme #57

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

NickVolynkin
Copy link

* 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
@moigagoo
Copy link
Contributor

@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.

─────────────────────
Project "Hello Foliant" created in /path/to/hello-foliant
```
```console
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants