Closed iamveritas closed 1 year ago
Need to update the syntax for these. The new syntax is as follows.
:::info Implementation location :::
We should transform this in the code first because I'm not sure if you will like the new style.
Also supported note, tip, caution, danger https://docusaurus.io/docs/markdown-features/admonitions
new script created ericpassmore-working branch to fix this scripts/process_admonitions.py
will merge later
One more case, in the example below need to consume the 'pipe' between ]] |
end of section and start of text. May want to move text till end of line into info block
[[info | Access Node]] | A local or remote EOSIO access node running nodeos is required for a client application or smart contract to interact with the blockchain.
One more case, in the example below need to consume the 'pipe' between
]] |
end of section and start of text. May want to move text till end of line into info block
[[info | Access Node]] | A local or remote EOSIO access node running nodeos is required for a client application or smart contract to interact with the blockchain.
There's another case: there might be multiple vertical lines with content:
[[info | Access Node]]
| content 1
| content 2
...
Each content 1, 2, etc. would render as a separate paragraph within the callout box.
Personally, I'd prefer working with the new codeblock syntax. I find it more friendly.
Reopening since the above case was not handled, which causes some callouts to not render correctly:
@ericpassmore
Hmm, this syntax is out of spec. Can you provide more info. There are pipes
Ok I see the info above each |
in the content. What is the expected rendering for those symbols. |
a separate paragraph.
The parsing is getting hairy. Sometimes a line following an admonition should not be part of the notice. Example
[[info]] | this is another inline body section.
Don't put me in admonition!!
Sometimes the line following an admonition should be part of the notice. Example
[[info | The genesis node is defined by the following:]]
| - Bears the name `eosio`
| - Produces blocks
| - Listens for HTTP request on 127.0.0.1:8888
| - Listens for peer connections requests on 127.0.0.1:9010
There is no closing character for admonition in the old format. Therefore I plan to support multi-line admonitions that start with |. I'm not going to support other scenarios. If other cases arise the markdown will need to be altered to match the docusaurus admonition markdown standard.
We need support for these custom markups below:
[[info | Implementation location]] [[warning | Implementation location]] [[caution | Implementation location]] [[danger | Implementation location]]
When they are present in an md file the text should render differently (color and background) for each of them.