Skip to content

Commit 274c553

Browse files
committed
Update README.md
1 parent c454798 commit 274c553

1 file changed

Lines changed: 4 additions & 7 deletions

File tree

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
![Static Badge](https://img.shields.io/badge/latest-v1.2.1-green)
2+
13
# `ledger` theme for GitHub Pages
24

35
Ledger is a documentation theme inspired by palmleafs and codex manuscripts. It is designed for clarity, readability, and zero-setup deployment on GitHub Pages, and is suitable for projects with a small set of doc files.
@@ -170,15 +172,13 @@ Standard Markdown elements are supported.
170172

171173
Admonitions must be written like this:
172174

173-
{% raw %}
174-
```liquid
175+
```
175176
{% include admonition.html
176177
type="warning"
177178
title="Warning"
178179
content="This one's a warning."
179180
%}
180181
```
181-
{% endraw %}
182182

183183
The value for the `type` variable must be one of `note`, `warning`, `tip`, or `caution`.
184184

@@ -192,8 +192,7 @@ Create a folder called `_data` in your project root (next to `_config.yml`). Pla
192192

193193
Then, create a Markdown file with content similar to the following code snippet (which specifies, inter alia, that the layout file called `api` should be used):
194194

195-
{% raw %}
196-
```liquid
195+
```
197196
---
198197
layout: api
199198
title: Title of the API
@@ -206,7 +205,6 @@ description: Description of the API
206205
{% endfor %}
207206
208207
```
209-
{% endraw %}
210208

211209
In this example, the `_data` folder contains a file called `api.json`, with the following structure, which is rendered as a static page:
212210

@@ -241,7 +239,6 @@ openapi: /assets/name_of_your_api_spec_file.json
241239

242240
The rendered page is interactive.
243241

244-
245242
## License
246243

247244
MIT

0 commit comments

Comments
 (0)