Skip to content

Commit

Permalink
Adds usage instructions to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeSteam committed Oct 8, 2024
1 parent 1d9aced commit a654af4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The theme is imported via `remote_theme: JakeSteam/minimaJake` in your `config.y
Native (liquid) features:

- Table of contents (toggleable & collapsible)
- Calendar with custom events
- Linkable headers
- Tag system
- Pagination improvements
Expand Down
14 changes: 13 additions & 1 deletion _posts/2024-10-08-v1.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,17 @@ This release adds a big new feature: Calendars!

Using the [original basic (and Russian) code](https://mikhail-yudin.ru/blog/frontend/jekyll-calendar-css-grid) for dynamically displaying a month's days and signifying some have events, a complex calendar is now possible.

There is [an example](/calendar/) on this site with sample data, give it a look! Intended for [my internet history site](https://history.jakelee.co.uk), the key features are:
To add to a site using `minimaJake`, just include this on any page ([example](https://github.com/JakeSteam/minimaJake/blob/main/calendar.md)):

{% raw %}

```
{% include custom/calendar.md %}
```

{% endraw %}

There is [a live example](/calendar/) on this site with sample data, give it a look! Intended for [my internet history site](https://history.jakelee.co.uk), the key features are:

### Dark mode & responsive support

Expand Down Expand Up @@ -76,3 +86,5 @@ Even the close button uses plain old HTML, thanks to a neat feature of `dialog`s
</form>
</dialog>
```

I'll likely do a longer write-up on [my programming blog](https://blog.jakelee.co.uk) once it's properly released, let me know if you want any extra features!

0 comments on commit a654af4

Please sign in to comment.