mirror of
https://github.com/welpo/tabi.git
synced 2025-10-11 07:46:15 +02:00
✨ feat(shortcodes): add remote_text shortcode (#305)
This commit is contained in:
parent
be9458cfad
commit
5bc593b676
4 changed files with 88 additions and 3 deletions
|
@ -1,7 +1,7 @@
|
|||
+++
|
||||
title = "Custom shortcodes"
|
||||
date = 2023-02-19
|
||||
updated = 2024-03-20
|
||||
updated = 2024-05-02
|
||||
description = "This theme includes some useful custom shortcodes that you can use to enhance your posts. Whether you want to display images that adapt to light and dark themes, or format a professional-looking reference section, these custom shortcodes have got you covered."
|
||||
|
||||
[taxonomies]
|
||||
|
@ -97,6 +97,32 @@ All other image shortcodes can be made into full-width by setting the optional p
|
|||
|
||||
## Text shortcodes
|
||||
|
||||
### Remote text
|
||||
|
||||
Embed text from a remote URL or a local file.
|
||||
|
||||
**Important**:
|
||||
|
||||
- **Remote VS local files**: If `src` starts with "http", it will be treated as a remote file. Otherwise, it assumes a local file path.
|
||||
- **Files access**: As it uses Zola's [`load_data`](https://www.getzola.org/documentation/templates/overview/#load-data), local files must be inside the Zola directory—see [File searching logic](https://www.getzola.org/documentation/templates/overview/#file-searching-logic).
|
||||
- **Code block formatting**: To display the text as a code block, you must manually add the Markdown code fences (backticks) and, optionally, specify the programming language for syntax highlighting.
|
||||
|
||||
#### Usage
|
||||
|
||||
Embedding a remote Python script within a code block with syntax highlighting:
|
||||
|
||||
````
|
||||
```python
|
||||
{{/* remote_text(src="https://example.com/script.py") */}}
|
||||
```
|
||||
````
|
||||
|
||||
Displaying text from a local file:
|
||||
|
||||
```
|
||||
{{/* remote_text(src="path/to/file.txt") */}}
|
||||
```
|
||||
|
||||
### Admonitions
|
||||
|
||||
Bring attention to information with these admonition shortcodes. They come in five `type`s: `note`, `tip`, `info`, `warning`, and `danger`.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue