Skip to content

Commit 2938f5e

Browse files
committed
docs: Add API reference
1 parent f4cf811 commit 2938f5e

File tree

10 files changed

+568
-887
lines changed

10 files changed

+568
-887
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules/
22
dist/
33
coverage/
4+
docs/README.md

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Here’s how you can use it to empower your projects:
2727
<!-- toc -->
2828

2929
- [Installation](#installation)
30+
- [API reference](#api-reference)
3031
- [Samples](#samples)
3132
- [What are 'Crystals' and 'Shards'? And why?](#what-are-crystals-and-shards-and-why)
3233
- [Introduction](#introduction)
@@ -40,7 +41,6 @@ Here’s how you can use it to empower your projects:
4041
- [Map](#map)
4142
- [Timestamp](#timestamp)
4243
- [Keep](#keep)
43-
- [API reference](#api-reference)
4444

4545
<!-- tocstop -->
4646

@@ -81,6 +81,10 @@ let crystalizer = new Crystalizer({
8181
});
8282
```
8383

84+
## API reference
85+
86+
crystalize.js / [Exports](docs/modules.md)
87+
8488
## Samples
8589

8690
Sample apps, as built, will be placed here and linked to `./samples`.
@@ -568,7 +572,3 @@ let crystalizer = new Crystalizer<Crystal, Shard>({
568572
keep: ['all'],
569573
});
570574
```
571-
572-
## API reference
573-
574-
TODO

docs/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

0 commit comments

Comments
 (0)