Callouts #466
Callouts #466
Conversation
- Add various examples of callout configurations - Add Liquid code for generating SCSS for each callout - Add a test file for callouts
- Restrict callouts to paragraphs and blockquotes. - Add `div.opaque` style. - Revert default opacity to 0.2. - Add a highlight callout. - Update configuration and customization docs. - Update styling tests..
- Remove outdated comments.
- Add a `custom` callout using a new color `pink`. - Update the docs for configuration and customization.
Implement enhancement suggested by @mattjlewis in just-the-docs#171 - Generate CSS for `.*-title` callouts - Add examples of markup for title customisation
|
This will be great, look forward to this! |
|
I'd also love to see this merged. |
|
This PR currently adjusts the level of the callout colors for the The addition of the |
- Add `callouts_opacity` configuration variable. - Add `callouts_level` configuration variable. - Allow `callouts_level: loud` for `light` and custom color schemes. - Reorganise and update docs for callouts. - Update `_config.yml` .
- Add `_config_dev.yml` for local serving with jekyll 4.2. - Add `_config_tests.yml` for local testing.
- Improve the levels of pink.
|
The configuration files for local testing have been updated, to avoid the need to edit bundle exec jekyll serve --config _config.yml,_config_dev.yml,_config_tests.yml |
|
Hi, we are also using this PR and worried about having to maintain our own fork (ResearchObject/ro-crate#141). I see tests, documentations, configurations, examples, great job @pdmosses! Would @pmarsceill detail what remains to fix to get it merged, and we can try to help out. |
|
@pdmosses what about a (configurable) icon on callouts? Like a lightbulb icon on an Idea callout Or should I handle that through css? |
|
👍 |
This PR combines (and resolves conflicts between) #448, #463, #466, #494, #495, #496, #498, and #572. The main aim is to facilitate use of several of the implemented features _together_, when using the fork as a remote theme. It should also simplify merging the included PRs into a future release. The branch [combination-rec-nav](https://github.com/pdmosses/just-the-docs/tree/combination-rec-nav) adds [multi-level navigation](#462) and (NEW:) [sibling links](#394) to the branch used for this PR. It includes updated [documentation for the navigation structure](https://pdmosses.github.io/just-the-docs/docs/navigation-structure/), and reorganised and extended [navigation tests](https://pdmosses.github.io/just-the-docs/tests/navigation/). The documentation and the tests can be browsed at the (temporary) [website published from the combination-rec-nav branch](https://pdmosses.github.io/just-the-docs/). _Caveat:_ The changes to v0.3.3 in this PR and #462 have not yet been reviewed or approved, and may need updating before merging into a release of the theme. If you use a branch from a PR as a remote theme, there is a risk of such updates affecting your website. Moreover, these branches are likely to be deleted after they have been merged. To avoid such problems, you could copy the branch that you want to use to your own fork of the theme. Co-authored-by: Matt Wang <[email protected]>
|
As this PR was merged in pre-release v0.4.0.rc1, I'm deleting the PR branch. Let me know if you're still using it, and none of the pre-releases of v0.4.0 works for you. |
7 participants
This PR implements support for common callouts, which is suggested as an enhancement in #171.
To use a callout, you need to configure its name, title (optional), and color, e.g.:
You can then use a kramdown block IAL to apply it to a single paragraph:
{: .highlight } A paragraphWith the dark color scheme it looks like this:
{: .note } A paragraphYou need to use a block quote to group larger content in a single callout:
{: .important } > A paragraph > > Another paragraph > > The last paragraphThe styling of the callouts uses code provided by @bradleybensmith
Suggestions for improvement are welcome!