Skip to content

Commit 6d9b98b

Browse files
authored
Add Effect TypeScript library docset (#5565)
1 parent 2a1e998 commit 6d9b98b

File tree

5 files changed

+86
-0
lines changed

5 files changed

+86
-0
lines changed

docsets/Effect/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Effect Docset
2+
3+
[Effect](https://effect.website/) is a powerful TypeScript library for building production-ready applications with features like typed errors, dependency injection, concurrency, and more.
4+
5+
## Author
6+
7+
Community contribution (not affiliated with the Effect team).
8+
9+
## Generation Instructions
10+
11+
### Prerequisites
12+
13+
- [dashing](https://github.com/technosophos/dashing) - Install via `brew install dashing` or `go install github.com/technosophos/dashing@latest`
14+
- `wget` for mirroring the documentation
15+
16+
### Steps
17+
18+
1. **Download the documentation:**
19+
20+
```bash
21+
wget --mirror --convert-links --adjust-extension --page-requisites \
22+
--no-parent https://effect-ts.github.io/effect/
23+
```
24+
25+
2. **Copy `dashing.json`** from this directory to your working directory.
26+
27+
3. **Build the docset:**
28+
29+
```bash
30+
dashing build effect-ts.github.io/effect --source effect-ts.github.io/effect
31+
```
32+
33+
4. **Archive for distribution:**
34+
35+
```bash
36+
tar --exclude='.DS_Store' -cvzf Effect.tgz Effect.docset
37+
```
38+
39+
## Notes
40+
41+
- The Effect documentation is generated from TypeDoc and uses the "just-the-docs" Jekyll theme
42+
- The docset includes all Effect ecosystem packages: `effect`, `@effect/platform`, `@effect/cli`, `@effect/cluster`, `@effect/sql`, and more
43+
- Approximately 13,700+ entries are indexed including Functions, Interfaces, Types, Classes, Namespaces, and Sections
44+
45+
## Known Issues
46+
47+
None currently known. Please report docset generation issues at [Dash-User-Contributions](https://github.com/Kapeli/Dash-User-Contributions/issues).

docsets/Effect/dashing.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"name": "Effect",
3+
"package": "effect",
4+
"index": "effect-ts.github.io/effect/index.html",
5+
"selectors": {
6+
"h2[id*='-interface']": "Interface",
7+
"h3[id*='-interface']": "Interface",
8+
"h2[id*='-class']": "Class",
9+
"h3[id*='-class']": "Class",
10+
"h2[id*='-type-alias']": "Type",
11+
"h3[id*='-type-alias']": "Type",
12+
"h2[id*='-namespace']": "Namespace",
13+
"h3[id*='-namespace']": "Namespace",
14+
"#main-content > h1:not([id*='-overview'])": "Section",
15+
"#main-content > h2:not([id*='-interface']):not([id*='-class']):not([id*='-type-alias']):not([id*='-namespace']):not([id*='-overview']):not([id='exports-grouped-by-category'])": "Function"
16+
},
17+
"ignore": [
18+
"ABOUT",
19+
"exports grouped by category",
20+
"Overview"
21+
],
22+
"icon32x32": "",
23+
"allowJS": false,
24+
"ExternalURL": ""
25+
}

docsets/Effect/docset.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"name": "Effect",
3+
"version": "3.19.14",
4+
"archive": "Effect.tgz",
5+
"author": {
6+
"name": "Cory Klein",
7+
"link": "https://github.com/coryfklein"
8+
},
9+
"aliases": [
10+
"effect-ts",
11+
"effectts",
12+
"effect typescript"
13+
]
14+
}

docsets/Effect/icon.png

547 Bytes
Loading

docsets/Effect/icon@2x.png

855 Bytes
Loading

0 commit comments

Comments
 (0)