Admonition directives #47
Conversation
jonas
commented
Oct 26, 2016
•
jonas
commented
|
A WIP branch to use this in Akka HTTP: jonas/akka-http@9e8c0be |
|
Awesome! :-) |
| @@ -366,3 +366,20 @@ case class VarsDirective(variables: Map[String, String]) extends ContainerBlockD | |||
| } | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
| * Adminition directive. | |||
jonas
force-pushed
the
admonition-directives
branch
from
444d125 to
e599f79
Compare
There was a problem hiding this comment.
Some comments.
Also could you add a release note here please for 0.2.6? https://github.com/lightbend/paradox/tree/master/notes
| @@ -0,0 +1,72 @@ | |||
| Additional directives | |||
There was a problem hiding this comment.
We need a better name here, otherwise this page either will be kitchen sink of directives, or we'll have more-additional-directives.md. Suggestion is "Callout box" callout-box.md. Who knows what a callout is? Hey it's better than "Additional directives".
There was a problem hiding this comment.
Sorry I didn't do a better job at researching a good name. Turns out that foundation has callouts.
| @@ -1,7 +1,7 @@ | |||
| Linking | |||
| ------- | |||
|
|
|||
| ### @ref link | |||
| ## @ref link | |||
There was a problem hiding this comment.
Isn't Linking with --- an h2? Why is @ref getting a promotion to h2 here?
There was a problem hiding this comment.
Yes, true. My main goal was to make the side menu more useful.
| @@ -3,29 +3,48 @@ | |||
| Templating | |||
| ---------- | |||
|
|
|||
| Paradox uses [StringTemplate][st] for the basic templating. For example: | |||
| Paradox uses [StringTemplate][st] for the basic templating. Template files have | |||
There was a problem hiding this comment.
I think this commit should be split into another PR.
| * | ||
| * Replaces property values in verbatim blocks. | ||
| */ | ||
| case class AdmonitionDirective(name: String, defaultTitle: String) extends ContainerBlockDirective(Array(name): _*) { |
There was a problem hiding this comment.
What do you think about renaming to CalloutDirective?
There was a problem hiding this comment.
Blame the other Jonas, @jboner, for "admonition" :-)
There was a problem hiding this comment.
At least blame Sphinx!
Makes `~docs/paradox` work as expected.
|
I need to find a way to hold your PR hostage so you can ship me jonas/tig#313 :-P |
jonas
force-pushed
the
admonition-directives
branch
from
e599f79 to
d4e3ee1
Compare
|
Let me know if I should leave foundation's background color for warnings.
|
|
@dwijnand I got the rendering part working parsing standout control characters emitted by |
|
As per color palette, my policy around the "generic" theme was to make it feel neutral as possible, which means make it kind of look like Github's documentation. See their warning and note callouts here: |
|
Awesome stuff! Really looking forward to this! |
|
Nice one! |
The warning border color is based on this generated palette: - https://coolors.co/4078c0-084c61-db504a-e3b505-4f6d7a
jonas
force-pushed
the
admonition-directives
branch
from
d4e3ee1 to
df2018b
Compare
|
@eed3si9n I personally find the warning colors a bit too dark which is why Foundation's warning color was left as is. Some examples: http://codepen.io/anon/pen/RGmgRx |
|
3 looks good. Thanks for working on this. |
