Skip to content

Commit 6400c81

Browse files
committed
Improves readme and jsdoc
1 parent 8462617 commit 6400c81

File tree

3 files changed

+26
-8
lines changed

3 files changed

+26
-8
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
11
# hibana
22

3-
Hibana 火花 (lit "fire flowers") are little sparks, shareable Helpers and Filters for «[Lume ルメ](https://lume.land/)», the fast Deno SSG by [Óscar Otero](https://oscarotero.com/). 🙏🏻
3+
Hibana 火花 (lit "fire flowers") are little sparks, shareable Helpers and Filters for «[Lume ルメ](https://lume.land/)», the fast Deno typescript SSG by [Óscar Otero](https://oscarotero.com/). 🙏🏻
44

55
With this repo I hope to learn more about Lume, Deno and typescript coding.
66

77
## Usage
88

9+
This library is published to https://deno.land/x/hibana, so you can import it from there, or directly from github.
10+
911
N.b. Github caches raw files for 10 min, so if you ever need the latest and don't want to wait, just "cache bust" it by appending `?1`, `?2` etc.
1012

13+
Import the hibana version in your import map in `deno.json`:
14+
15+
```json
16+
"imports": {
17+
"lume/": "https://deno.land/x/lume@v3.0.3/",
18+
"lume/cms/": "https://cdn.jsdelivr.net/gh/lumeland/cms@0.12.0/",
19+
"lume/jsx-runtime": "https://deno.land/x/ssx@v0.1.10/jsx-runtime.ts",
20+
"hibana/": "https://deno.land/x/hibana/v1.0.15/"
21+
},...
1122
```
12-
import { cssBanner, shuffle } from "https://raw.githubusercontent.com/RickCogley/hibana/v1.0.0/mod.ts";
13-
import cssBanner from "https://raw.githubusercontent.com/RickCogley/hibana/v0.5.0/plugins/css_banner.ts?1";
14-
import shuffle from "https://raw.githubusercontent.com/RickCogley/hibana/v0.5.0/plugins/shuffle.ts?1";
15-
import { cssBanner, shuffle, deferPagefind, externalLinksIcon } from "https://raw.githubusercontent.com/RickCogley/hibana/v1.0.0/mod.ts";
23+
24+
Then in `_config.ts`, import the needed modules from `hibana`, no version needed.
25+
26+
```ts
27+
import { cssBanner, shuffle } from "hibana/mod.ts";
28+
import { cssBanner } from "https://raw.githubusercontent.com/RickCogley/hibana/v1.0.15/plugins/css_banner.ts?1";
29+
import { cssBanner, shuffle, deferPagefind, externalLinksIcon } from "hibana/mod.ts";
30+
etc
1631
```
1732

1833
### css_banner.ts

deno.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@rick/hibana",
3-
"version": "1.0.14",
3+
"version": "1.0.15",
44
"license": "MIT",
55
"exports": "./mod.ts",
66
"imports": {

mod.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,14 @@
2222
* "lume/": "https://deno.land/x/lume@v3.0.3/",
2323
* "lume/cms/": "https://cdn.jsdelivr.net/gh/lumeland/cms@0.12.0/",
2424
* "lume/jsx-runtime": "https://deno.land/x/ssx@v0.1.10/jsx-runtime.ts",
25-
* "hibana/": "https://deno.land/x/hibana/v1.0.14/"
25+
* "hibana/": "https://deno.land/x/hibana/v1.0.15/"
2626
* },...
2727
*
2828
* // Github Direct:
29-
* "hibana/": "https://raw.githubusercontent.com/RickCogley/hibana/v1.0.14/"
29+
* "hibana/": "https://raw.githubusercontent.com/RickCogley/hibana/v1.0.15/"
30+
*
31+
* // Then import it in your Lume config:
32+
* import { cssBanner, shuffle, deferPagefind, externalLinksIcon } from "hibana/mod.ts";
3033
*/
3134

3235
// Plugins

0 commit comments

Comments
 (0)