Skip to content

Commit

Permalink
docs: harmonise and clean (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
mcanouil authored May 18, 2024
1 parent d719914 commit 30d9409
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ Then you can use the span syntax markup to highlight text in your document, *e.g
[Blue]{color="#0000FF" bg-color="#ABC123"} # US
```

## Example
## Examples

Here is the source code for a minimal example: [example.qmd](example.qmd).
Here is the source code for a minimal example: [`example.qmd`](example.qmd).

This is the output of `example.qmd` for:
Outputs of `example.qmd`:

- [HTML](https://m.canouil.dev/quarto-highlight-text/)
- [Typst/PDF](https://m.canouil.dev/quarto-highlight-text/highlight-typst.pdf)
Expand Down
10 changes: 5 additions & 5 deletions example.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ quarto add mcanouil/quarto-highlight-text
This will install the extension under the `_extensions` subdirectory.
If you're using version control, you will want to check in this directory.

## Using {.smaller}
## Using

To use the extension, add the following to your document's front matter:

Expand All @@ -55,8 +55,8 @@ filters:
Then you can use the span syntax markup to highlight text in your document.
```markdown
[Text]{colour="#FFFFFF" bg-colour="#b22222"}
[Text]{color="#FFFFFF" bg-color="#b22222"}
[Red]{colour="#b22222" bg-colour="#abc123"} # UK
[Blue]{color="#0000FF" bg-color="#ABC123"} # US
```

## Font Colour
Expand Down Expand Up @@ -87,7 +87,7 @@ Then you can use the span syntax markup to highlight text in your document.

[Blue background]{bg-color="#0000FF"}

## Font and Background Colour {.smaller}
## Font and Background Colour

```markdown
[White text, Red background]{
Expand All @@ -105,7 +105,7 @@ Then you can use the span syntax markup to highlight text in your document.

[White text, Blue background]{color="#FFFFFF" bg-color="#0000FF"}

## More Examples {.smaller}
## More Examples

```markdown
[text [with a link](https://quarto.org/)]{
Expand Down

0 comments on commit 30d9409

Please sign in to comment.