Skip to content

Commit

Permalink
update: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TOsmanov committed Aug 20, 2024
1 parent 8058392 commit b312fc2
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

# EscapeCode and UnescapeCode

> **Wraning**
>
> Starting from version `1.0.5`, the preprocessor uses the [marko parser](https://github.com/frostming/marko/tree/6ee598746bc9a76e62a158c5aa5226a3d65c0864).
> This is necessary to more accurately identify code blocks nested in other markdown elements. But using the parser imposes the following restrictions:
> - the loose lists in the blockquote will be converted to tight lists after processing by the preprocessor,
> - the indent of the list items will be converted to 2 spaces after processing by the preprocessor.
>
> If your documentation does not use deep nesting of markdown elements, you may want to use version `1.0.4`, as it is more stable. For install version `1.0.4`, run:
> ```
> pip install foliantcontrib.escapecode==1.0.4
> ```
>
> If you have any errors when using the escapecode preprocessor, please [create an issue](https://github.com/foliant-docs/foliantcontrib.escapecode/issues/new/choose).
EscapeCode and UnescapeCode preprocessors work in pair.
EscapeCode finds in the source Markdown content the parts that should not be modified by any next preprocessors. Examples of content that should be left raw: fence code blocks, pre code blocks, inline code.
Expand Down Expand Up @@ -140,8 +154,6 @@ Meanings of parameters:

## Usage

> The loose lists in the blockquote will be converted to tight lists after processing by the preprocessor

Below you can see an example of Markdown content with code blocks and inline code.

# Heading
Expand Down

0 comments on commit b312fc2

Please sign in to comment.