Skip to content

Commit

Permalink
More documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Oct 20, 2024
1 parent 9d6460e commit 40af599
Show file tree
Hide file tree
Showing 5 changed files with 107 additions and 54 deletions.
3 changes: 3 additions & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ website:
contents:
- text: "Home"
file: index.qmd
- text: "Example"
file: qcustom-callout-example.qmd
- section: "Support"
contents:
- text: "FAQ"
Expand All @@ -26,6 +28,7 @@ website:
- section: "Extra"
contents:
- qcustom-callout-release-notes.qmd
- qcustom-callout-dev-notes.qmd

format:
html:
Expand Down
19 changes: 19 additions & 0 deletions docs/qcustom-callout-dev-notes.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Custom Callout Development Notes
---


For more information about callouts, custom callouts, and Quarto you can refer to the following resources:

- Discussion/Issue Tickets:
- [Custom filter for processing Github/Obsidian style callouts stopped working - any tips? ](https://github.com/quarto-dev/quarto-cli/discussions/6550)
- [Creating new callout types (and sharing as an extension)?](https://github.com/quarto-dev/quarto-cli/discussions/7753)
- [Custom callout boxes](https://github.com/quarto-dev/quarto-cli/issues/844)
- Quarto Documentation
- [Quarto: Callout Lua API Reference](https://quarto.org/docs/prerelease/1.3/custom-ast-nodes/callout.html)
- [Quarto: Callout Blocks](https://quarto.org/docs/authoring/callouts.html)
- Quarto Source Code
- SCSS: <https://github.com/quarto-dev/quarto-cli/blob/71945532e1fc1a5cf113117f6d5ff5bee3991797/src/resources/formats/html/bootstrap/_bootstrap-rules.scss#L1520-L1620>
- LaTeX: <https://github.com/quarto-dev/quarto-cli/blob/71945532e1fc1a5cf113117f6d5ff5bee3991797/src/resources/filters/quarto-pre/meta.lua#L11>
- Community Extensions
- [Custom Numbered Blocks](https://github.com/ute/custom-numbered-blocks) by [Ute Hahn](https://github.com/ute)
85 changes: 85 additions & 0 deletions docs/qcustom-callout-example.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "My Document"
format:
html:
css: https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css

custom-callout:
todo:
icon-symbol: "📝"
color: "pink"
jjb:
icon: true
title: "fix for JJB"
icon-symbol: "⚠️"
color: "#FFA500"
test:
title: "Test feature"
icon: true
color: "#801410"
filters:
- custom-callout
---

## Custom Callouts

This section provides examples of custom callouts.

### Sample Custom Callouts

::: todo
Hello there!
:::

::: jjb
Please address this issue ...
:::

::: test
Let's do a feature test!
:::


### Icon

::: {.todo icon="false" title="Todo with No Icon"}
Demo of `icon="false"`.
:::

### Collapse

::: {.todo collapse="true" title="Collapsed Todo with Title"}
Demo of `collapse="true"`.
:::

### Appearance

::: {.todo appearance="simple" title="Todo with Simple Appearance"}
Demo of `appearance="simple"`.
:::

::: {.todo appearance="minimal" title="Todo with Minimal Appearance"}
Demo of `appearance="minimal"`.
:::


## Official Quarto Callout

This section provides examples of the official Quarto callout.

::: {.callout-note}
Hello!
:::

::: {.callout-note collapse="true" title="Collapsed Note with Title"}
Demo of `collapse="true"`
:::

::: {.callout-note appearance="simple" title="Simple Note Appearance with Title"}
Demo of `appearance="simple"`.
:::

::: {.callout-note appearance="minimal" title="Minimal Note Appearance with Title"}
Demo of `appearance="minimal"`.
:::

16 changes: 0 additions & 16 deletions docs/qcustom-callout-faq.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -141,19 +141,3 @@ The [quarto-custom-numbered-blocks](https://github.com/ute/custom-numbered-block
This makes it great for academic or technical documents requiring numbered theorems, examples, or exercises. Both extensions can be used in the same document if needed, but be mindful of potential styling conflicts and filter ordering.

One notable difference is that the `quarto-custom-callout` extension is built ontop of Quarto's built-in callout functionality, while `quarto-custom-numbered-blocks` creates its own block type.

## Where can I find more information about custom callouts?

For more information about custom callouts, you can refer to the following resources:

- Discussion/Issue Tickets:
- [Custom filter for processing Github/Obsidian style callouts stopped working - any tips? ](https://github.com/quarto-dev/quarto-cli/discussions/6550)
- [Creating new callout types (and sharing as an extension)?](https://github.com/quarto-dev/quarto-cli/discussions/7753)
- [Custom callout boxes](https://github.com/quarto-dev/quarto-cli/issues/844)
- Quarto Documentation
- [Quarto: Callout Lua API Reference](https://quarto.org/docs/prerelease/1.3/custom-ast-nodes/callout.html)
- [Quarto: Callout Blocks](https://quarto.org/docs/authoring/callouts.html)
- Quarto Source Code
- SCSS: <https://github.com/quarto-dev/quarto-cli/blob/71945532e1fc1a5cf113117f6d5ff5bee3991797/src/resources/formats/html/bootstrap/_bootstrap-rules.scss#L1520-L1620>
- LaTeX: <https://github.com/quarto-dev/quarto-cli/blob/71945532e1fc1a5cf113117f6d5ff5bee3991797/src/resources/filters/quarto-pre/meta.lua#L11>

38 changes: 0 additions & 38 deletions example.qmd

This file was deleted.

0 comments on commit 40af599

Please sign in to comment.