egoist / docute

📚 Effortless documentation, done right.
https://docute.egoist.dev
MIT License
3.8k stars 427 forks source link

Support shorthand for css helpers #145

Open ulivz opened 6 years ago

ulivz commented 6 years ago

Tip

<p class="tip">tip</p>

Can be simplified as:

?> tip

Warning

<p class="warning">warning</p>

Can be simplified as:

!> warning

Only need to do some enhancement for the marked renderer, I'm glad to contribute for it.

But I don't know what the syntax of .danger and .no-bg should be, what do you think?

egoist commented 6 years ago

I'm not accepting new feature requests to current version (v3) of docute since I want to put all efforts to developing docute v4.

Bug fixes are still welcome though.

ulivz commented 6 years ago

Cool, just moving it to the v4 graph, BTW, can you create a v4 label to indicate it? I will work for it when you start v4. thanks.

egoist commented 6 years ago

v4 is available at https://github.com/egoist/docute/tree/dev (far from being completed)

btw I think some syntax like this might be better:

::: warning
Some __warning__...
:::

Not sure about which symbol fits better though.

Docute v4 is using markdown-it too, so it should be easier to make plugins.

ulivz commented 6 years ago

@egoist This syntax looks awesome. 👏