Skip to content

Commit

Permalink
Merge pull request #49 from welpo/docs/markdown-examples
Browse files Browse the repository at this point in the history
📝 docs: use markdown to showcase theme's capabilities
  • Loading branch information
welpo authored Feb 19, 2023
2 parents a1c16b0 + 2f07137 commit b387f3b
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 55 deletions.
2 changes: 1 addition & 1 deletion content/almost-no-js.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Almost no JavaScript"
date = "2021-04-02"
date = "2022-12-03"
[taxonomies]
tags = ["test"]
+++
Expand Down
26 changes: 0 additions & 26 deletions content/lorem2.md

This file was deleted.

27 changes: 1 addition & 26 deletions content/markdown.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,10 @@
+++
title = "Markdown Test"
title = "Markdown examples"
date = "2023-01-31"
[taxonomies]
tags = ["markdown", "test"]
+++

## Image shortcodes

### Invertible image

You can use this shortcode for graphs, line drawings, diagrams…

{{ invertible_image(src="$BASE_URL/img/graph.webp", alt="Invertible graph") }}

Usage:

```
{{/* invertible_image(src="img/graph.webp", alt="Invertible graph") */}}
```

### Dimmable image

Images with too much brightness or contrast can be jarring against a dark background. Here's an example of a photograph that dims when the dark theme is active.

{{ dimmable_image(src="$BASE_URL/img/desert_by_oskerwyld.webp", alt="Photograph of a desert, heavenly sky") }}

Usage:

```
{{/* dimmable_image(src="img/desert_by_oskerwyld.webp", alt="Photograph of a desert, heavenly sky") */}}
```

## Table

Expand Down
32 changes: 32 additions & 0 deletions content/shortcodes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
+++
title = "Custom shortcodes"
date = "2023-02-19"
[taxonomies]
tags = ["test", "shortcodes"]
+++

## Image shortcodes

### Invertible image

You can use this shortcode for graphs, line drawings, diagrams…

{{ invertible_image(src="$BASE_URL/img/graph.webp", alt="Invertible graph") }}

Usage:

```
{{/* invertible_image(src="img/graph.webp", alt="Invertible graph") */}}
```

### Dimmable image

Images with too much brightness or contrast can be jarring against a dark background. Here's an example of a photograph that dims when the dark theme is active.

{{ dimmable_image(src="$BASE_URL/img/desert_by_oskerwyld.webp", alt="Photograph of a desert, heavenly sky") }}

Usage:

```
{{/* dimmable_image(src="img/desert_by_oskerwyld.webp", alt="Photograph of a desert, heavenly sky") */}}
```
4 changes: 2 additions & 2 deletions content/toc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Table of Contents Test"
date = "2022-11-22"
title = "Table of Contents"
date = "2023-01-02"
[taxonomies]
tags = ["test"]

Expand Down

0 comments on commit b387f3b

Please sign in to comment.