Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docsets/Effect/Effect.tgz
Binary file not shown.
47 changes: 47 additions & 0 deletions docsets/Effect/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Effect Docset

[Effect](https://effect.website/) is a powerful TypeScript library for building production-ready applications with features like typed errors, dependency injection, concurrency, and more.

## Author

Community contribution (not affiliated with the Effect team).

## Generation Instructions

### Prerequisites

- [dashing](https://github.com/technosophos/dashing) - Install via `brew install dashing` or `go install github.com/technosophos/dashing@latest`
- `wget` for mirroring the documentation

### Steps

1. **Download the documentation:**

```bash
wget --mirror --convert-links --adjust-extension --page-requisites \
--no-parent https://effect-ts.github.io/effect/
```

2. **Copy `dashing.json`** from this directory to your working directory.

3. **Build the docset:**

```bash
dashing build effect-ts.github.io/effect --source effect-ts.github.io/effect
```

4. **Archive for distribution:**

```bash
tar --exclude='.DS_Store' -cvzf Effect.tgz Effect.docset
```

## Notes

- The Effect documentation is generated from TypeDoc and uses the "just-the-docs" Jekyll theme
- The docset includes all Effect ecosystem packages: `effect`, `@effect/platform`, `@effect/cli`, `@effect/cluster`, `@effect/sql`, and more
- Approximately 13,700+ entries are indexed including Functions, Interfaces, Types, Classes, Namespaces, and Sections

## Known Issues

None currently known. Please report docset generation issues at [Dash-User-Contributions](https://github.com/Kapeli/Dash-User-Contributions/issues).
25 changes: 25 additions & 0 deletions docsets/Effect/dashing.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "Effect",
"package": "effect",
"index": "effect-ts.github.io/effect/index.html",
"selectors": {
"h2[id*='-interface']": "Interface",
"h3[id*='-interface']": "Interface",
"h2[id*='-class']": "Class",
"h3[id*='-class']": "Class",
"h2[id*='-type-alias']": "Type",
"h3[id*='-type-alias']": "Type",
"h2[id*='-namespace']": "Namespace",
"h3[id*='-namespace']": "Namespace",
"#main-content > h1:not([id*='-overview'])": "Section",
"#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"
},
"ignore": [
"ABOUT",
"exports grouped by category",
"Overview"
],
"icon32x32": "",
"allowJS": false,
"ExternalURL": ""
}
14 changes: 14 additions & 0 deletions docsets/Effect/docset.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "Effect",
"version": "3.19.14",
"archive": "Effect.tgz",
"author": {
"name": "Cory Klein",
"link": "https://github.com/coryfklein"
},
"aliases": [
"effect-ts",
"effectts",
"effect typescript"
]
}
Binary file added docsets/Effect/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docsets/Effect/icon@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading