Skip to content

Commit

Permalink
docs(readme): update section about directive syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
d3m1d0v committed Nov 13, 2024
1 parent b6f59af commit 1341fc9
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,11 @@ This file contains info on the following topics:

## Syntax

This plugin uses the directive syntax [proposed](https://talk.commonmark.org/t/generic-directives-plugins-syntax/444) in the CommonMark community, indicated by a block-level double colon at the beginning and end of a block. This HTML directives use `::: html` to open an HTML block, followed by your HTML content, and then `:::` to close the block. The number of empty lines before or after the opening or closing block is not significant.

Please note:

- Nested content within the block will not be parsed as Markdown.
- Embedded directives within the block are not supported.
- Inline directives are not yet supported.
This plugin uses the container block directive syntax. For more information see here: [diplodoc-platform/directive](https://github.com/diplodoc-platform/directive/?tab=readme-ov-file#directive-syntax).

Simple example:

```
```md
::: html

<div>Your HTML code is here</div>
Expand All @@ -38,8 +32,9 @@ Simple example:

Example with some styles:

```
```md
::: html

<style>
<style>
:root {
Expand Down

0 comments on commit 1341fc9

Please sign in to comment.