Skip to content

Commit

Permalink
Improve project documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yaph committed Jun 6, 2023
1 parent c159923 commit ff9bc75
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# ChatGPT Export Browser Bookmarklet

This browser bookmarklet enables you to export conversations with ChatGPT as markdown files. It uses the package `html-to-md` for converting HTML to markdown. The minified version of the package is loaded dynamically via a script tag, so the compiled JavaScript code is not too long be saved as a browser bookmark.
The ChatGPT Export bookmarklet is a convenient tool that allows you to effortlessly export conversations with ChatGPT as markdown files. With this bookmarklet, you can capture and save your ChatGPT conversations in a readable format for easy reference and sharing.

## Installation

To get started, simply visit the [ChatGPT to Markdown web page](https://geeksta.net/tools/chatgpt-to-markdown/) and drag the bookmarklet link to your browser's bookmark toolbar. You can also review the source code of the link to ensure its integrity and functionality.

Alternatively, if you prefer a more hands-on approach, you can clone this repository, install the necessary dependencies, and compile the code on your own machine.

## How it works

Once the bookmarklet link is clicked on a ChatGPT conversation page, it dynamically adds a script tag and loads the `html-to-md` JavaScript package. The `document.body` is then cloned and modified in the cloned version to remove any unnecessary information, ensuring a clean and concise output. Finally, the resulting HTML code is converted to markdown format and downloaded as a text file. The file is automatically named based on the conversation's title in the ChatGPT interface.

Please note that the `html-to-md` package is loaded dynamically to avoid exceeding bookmarklet size limitations when including it in the compiled code.

With the ChatGPT Export browser bookmarklet, archiving and sharing your ChatGPT conversations as markdown files becomes a seamless process, enhancing your productivity and collaboration.
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
"build": "./build.js"
},
"type": "module",
"author": "Ramiro Gómez",
"description": "",
"homepage": "https://geeksta.net/tools/chatgpt-to-markdown/",
"author": "Ramiro Gómez (https://ramiro.org)",
"license": "MIT",
"description": "A browser bookmarklet for exporting conversations with ChatGPT as markdown files.",
"dependencies": {
"esbuild": "0.17.18",
"esbuild-plugin-bookmarklet": "^1.0.0",
Expand Down

0 comments on commit ff9bc75

Please sign in to comment.