https://github.com/guillempuche/effect_docs_for_chatgpt
A convenient repository to convert into comprehensive PDFs the Effect documentation, and the guides and examples of the official Effect repo and Effect HTTP. Optimized for ChatGPT integration.
https://github.com/guillempuche/effect_docs_for_chatgpt
chatgpt chatgpt-plugin deno effect effect-http effect-schema effect-ts
Last synced: 9 months ago
JSON representation
A convenient repository to convert into comprehensive PDFs the Effect documentation, and the guides and examples of the official Effect repo and Effect HTTP. Optimized for ChatGPT integration.
- Host: GitHub
- URL: https://github.com/guillempuche/effect_docs_for_chatgpt
- Owner: guillempuche
- Created: 2024-06-17T22:23:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-13T12:22:56.000Z (almost 2 years ago)
- Last Synced: 2025-08-16T04:02:37.169Z (10 months ago)
- Topics: chatgpt, chatgpt-plugin, deno, effect, effect-http, effect-schema, effect-ts
- Language: TypeScript
- Homepage: https://chatgpt.com/g/g-9phxaKORM-effectjs-docs
- Size: 12.2 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Effect Documentation PDF and Markdown Generator for ChatGPT
This guide explains how to create a PDF or markdown file from the Effect documentation, README guides, and examples.
## Prerequisites
- **Deno:** Make sure Deno is installed on your system. If not, you can install it from [Deno's official website](https://deno.land/).
## Setup
### Clone the Necessary Repositories
First, clone the Effect Website and Effect Github repositories:
```bash
git clone https://github.com/Effect-TS/website.git
git clone https://github.com/Effect-TS/effect.git
git clone https://github.com/sukovanej/effect-http.git
```
Next, in the same directory where you cloned the Effect Website, clone your Deno PDF generator repository:
```bash
git clone https://github.com/guillempuche/effect_docs_for_chatgpt.git
```
Your directory structure should now look something like this:
```txt
/some-folder
|-- /effect_docs_for_chatgpt
|-- /effect
|-- /effect-http
|-- /website
```
## Usage
Navigate to the Deno PDF generator directory and run the following command:
```bash
cd effect_docs_for_chatgpt
deno task generate-pdf [format:pdf|md] [outputFileName]
```
This command will convert the Markdown files found in the `../website/content/docs` directory and include content from the `../effect` repository into a single PDF or Markdown file named `documentation`. The last format and the document name arguments are optional.
## Example Command
If all repositories are cloned under your home directory, the command would look like this:
```bash
deno task generate-pdf ../website/content/docs ../effect ../effect-http md output <-- It will generate "output.md"
deno task generate-pdf ../website/content/docs ../effect ../effect-http pdf <-- It will generate "documentation.pdf"
deno task generate-pdf ../website/content/docs ../effect ../effect-http <-- It will generate "documentation.pdf"
```
## Additional Commands
Within the Deno PDF generator repository, you have access to other useful tasks:
- **Linting**: `deno lint` to check for stylistic errors.
- **Formatting**: `deno fmt` to format the source code.
## Troubleshooting
- Ensure you have read and write permissions for the directories involved.
- Confirm that all paths are correctly specified in the commands.
- Check that Deno is correctly installed by running `deno --version`.
- If you encounter errors related to Deno's permissions, ensure the script in your `deno.jsonc` file has the necessary permissions flags set.