Add variants section to docs #282
Conversation
|
Also the |
|
You are a madman! I was going to be happy to even see a PR come through that updated a single page 😄 The only change I would love to make if you don't mind is replacing this language:
I think phrasing it that way made sense for the SVG page where no variants are generated at all, but for modules that do have variants I think it's more useful to say:
...or:
Thanks man, this is amazing! |
|
Oh, re: flexbox stuff, it is admittedly a bit of a tricky one. We considered making each section it's own module but it seemed unnecessary; I think people want all of flexbox or none of it. I think we can just copy and paste the same language on each page, and maybe add a note like:
...after the code sample block or something? |
|
Figured I just do every doc page, so this one is done 🙂 Will make the extra note for the What about extracting into a separate component? |
|
I don't mind the idea of creating a partial for it but would want to try and make it flexible so we could still tweak the language per-page if necessary, or provide a different code sample if we wanted to. |
|
@adamwathan I think we can start with a partial for almost all the utility pages, but have a custom piece on the special pages ( |
| } | ||
| ``` | ||
|
|
||
| Note that modifying the `flexbox property will affect what variants are generated for _all_ flexbox modules, not just the align-content utilities. |
There was a problem hiding this comment.
Missing closing backtick here after flexbox
|
Fixed in 923a5a2 🙂 |
|
@adamwathan Do you prefer the use of the Prism library for the syntax highlighting or do I create a custom version like in the I think the custom one looks a bit nicer with the comments' color, less spacing for the "tabs", ... |
|
Yeah I’m ok with using a custom one here, it makes it easier to do a nice diff-ish format where we can show both the default variants and a customized version for each example 👍🏻 |
|
tbh, I was more thinking about something like (I like the highlight of the strings): |
|
Yeah fine to just use normal Prism stuff like we already are too, honestly no big deal to me either way. It's nice to show the default values in code is all, but maybe could add that later as just another code block after the first sentence about the default value. A bit annoying just because the code blocks take up a lot of space since we show the full context, which I also think is important. |
|
I like the diff-ish idea, but also like the Prism highlighting 😛
|
|
@adamwathan All is extracted to a partial 🙂 |
|
@adamwathan Don't know if it's a good idea to make the partial more complicated to also support docs like the |
|
I think just keep those as done manually with no partial for now 👍🏻
…On Sun, Dec 3, 2017 at 9:49 AM Michaël De Boey ***@***.***> wrote:
@adamwathan <https://github.com/adamwathan> Don't know if it's a good
idea to make the partial more complicated to also support docs like the
svg and spacing ones?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#282 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AEH3bI4h2jEqgIAkfl7CpmBadwJIwwOYks5s8rUMgaJpZM4QzYhQ>
.
|
|
OK then this one can be merged I think 🙂 Maybe @reinink or @davidhemphill have some thoughts about this one yet? 🙂 |
MichaelDeBoey
changed the title
|
Merged, thanks! |
2 participants
As requested by @adamwathan on Twitter 🙂
Not all is done yet, but thinking about making a partial for it?