jekyll-chatgpt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb1b5f419fe7df8334c5248d953838081ac4c8237a202b259c2f4fb2267878f1
+  data.tar.gz: 12271c751c986329d8e8590c52cadcee09f6e565f517101ba7ce9295ba77d92f
+SHA512:
+  metadata.gz: 3d06af997f0486c935098393a264e2e3511374a73bcf9a655bb429ea78264b47eed601a6a5909f1fc59716c1e39b2b786ee68a465f5b850a8a5a23a05e89cec9
+  data.tar.gz: 0601fc5c41c7da82658c2f40376fee4388664c9c326e506fbef93cf2cc53a0bcd21129fdeb0a5e498cc5c6a111f023644e0fe966954b488f3aa34d69c23248ce

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Stylez/OptionalBooleanParameter:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll_chatgpt.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 pcouy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# JekyllChatgpt
+
+This plugin inctroduces a `chatgpt` Liquid filter that formats ChatGPT conversations. It only uses CSS to navigate in branching conversations. A [live demo of deploying the demo branch of this repository to Github pages is available](https://pierre-couy.dev/jekyll-chatgpt)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add jekyll-chatgpt
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install jekyll-chatgpt
+
+Optionally, include a stylesheet for code syntax highlighting in ChatGPT output. If you already have a code highlighting theme set up for your site, it should automatically be used.
+
+## Usage
+
+### Including a conversation
+
+1. Download a conversation from [your ChatGPT history](https://chat.openai.com/). When on the ChatGPT web page, open your browser dev-tools (usually using F12) and go to the "Network" tab. Now, pick a conversation in the web-app. The URL in your browser should now look like `chat.openapi.com/chat/{some-random-looking-id}`. In the network tab of the developer tools, find the request to `{some-random-looking-id}` and right-click on it and pick "Copy > Copy response". You can now paste what you just copied into a JSON file inside your `_data` folder (for instance, `_data/chatgpt/test_conversation.json`).
+2. You can now use `{{ site.data.chatgpt['test_conversation'] | chatgpt }}` anywhere in your liquid-rendered content to include the conversation in your website. This will render markdown in messages by default. You can disable markdown rendering by passing the `false` argument to the filter : `{{ site.data.chatgpt['test_conversation'] | chatgpt: false }}`.
+
+### Customizing the colors
+
+The necessary styles will automatically be inlined when using the filter. You can override the default colors by providing the following variables in your `_sass/_colors.sass` file : `$color1`, `$color1-alt`, `$color2`, `$color2-alt`, `$cyan`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll_chatgpt.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/chatgpt.html

@@ -0,0 +1,10 @@
+{% unless chatgpt_style_included %}
+    <link rel="stylesheet" type="text/css" href="{{ 'chatgpt.css' | relative_url }}">
+    {% assign chatgpt_style_included = true %}
+{% endunless %}
+<section class="chatgpt-conversation">
+    <h1>{{ conversation.title }}</h1>
+    {% assign message=conversation.mapping | find_exp:"item", "item.parent == nil" %}
+    {% assign messages=conversation.mapping | where_exp:"item", "item.parent == nil"  %}
+    {% include chatgpt_message.html %}
+</section>

data/lib/chatgpt.sass

@@ -0,0 +1,70 @@
+$color1: #fff !default
+$color1-alt: #aaa !default
+$color2: #cc3 !default
+$color2-alt: #c3c !default
+$cyan: #2aa198 !default
+
+.chatgpt-conversation
+  $tab-border: $color1-alt
+  position: relative
+  height: 400px
+  overflow-y: scroll
+  border: 1px solid $tab-border
+  margin: 2em 0.5em
+
+  .chatgpt-message
+    display: none
+    position: absolute
+    left: 0
+    width: 100%
+    top: 1.5em
+  .chatgpt-control:checked ~ .chatgpt-message
+    display: block
+    &>.chatgpt-messagebody
+      margin-bottom: 0.5em
+      &>pre
+        display: inline
+        word-wrap: normal
+        white-space: pre-wrap
+      &>p
+        margin-block-start: 0.25em
+        margin-top: 0.25em
+  &>.chatgpt-message
+    display: block
+    top: 3em
+
+  .chatgpt-role-user::before
+    content: "User : "
+    color: $color2-alt
+    /*border: 1px solid $color1-alt
+  .chatgpt-role-assistant::before
+    content: "ChatGPT : "
+    color: $color2
+    /*border: 1px solid $color2
+
+  .chatgpt-messagechild
+    position: relative
+    .chatgpt-control
+      position: absolute
+      left: -300vw
+    &:only-child 
+      & > label
+        display: none
+      & > .chatgpt-message
+        top: 0
+    & > label
+      position: relative
+      display: block
+      float: left
+      padding-right: 0.2em
+      padding-left: 0.2em
+      margin-top: 0.1em
+      &:first-child
+        margin-left: 0.3em
+      border-bottom: 1px solid $tab-border
+    .chatgpt-messagechild:first-child > label
+      margin-left: 0.3em
+    .chatgpt-control:checked + label
+      color: $cyan
+      border: 1px solid $tab-border
+      border-bottom: none

data/lib/chatgpt_message.html

@@ -0,0 +1,32 @@
+{% assign outer_message=messages | last %}
+<div class="chatgpt-message" id="{{outer_message.id}}">
+    {% if outer_message.message %}
+        <div class="chatgpt-messagebody chatgpt-role-{{ outer_message.message.author.role }}">
+            {% if mdfy %}
+                {{ outer_message.message.content.parts[0] | markdownify }}
+            {% else %}
+                <pre>{{ outer_message.message.content.parts[0] }}</pre>
+            {% endif %}
+        </div>
+    {% endif %}
+    <div class="chatgpt-messagechildren">
+    {% for child_id in outer_message.children %}
+        <!-- D {% increment depth %} -->
+        {% assign inner_message=conversation.mapping[child_id] %}
+        {% assign messages = messages | push: inner_message %}
+        <div class="chatgpt-messagechild">
+            <input type="radio"
+                name="chatgpt-{{ outer_message.id }}"
+                id="chatgpt-control-{{ inner_message.id }}"
+                class="chatgpt-control"
+                {% if forloop.first %}checked{% endif %}
+            >
+            <label for="chatgpt-control-{{ inner_message.id }}">{{ forloop.index }}</label>
+            {% include chatgpt_message.html %}
+        </div>
+        {% assign messages = messages | slice: 0, depth %}
+        {% assign outer_message=messages.last %}
+        <!-- D {% decrement depth %} -->
+    {% endfor %}
+    </div>
+</div>

data/lib/jekyll-chatgpt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllChatgpt
+  VERSION = "0.1.0"
+end

data/lib/jekyll-chatgpt.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "jekyll-chatgpt/version"
+require "liquid"
+
+module JekyllChatgpt
+  class Error < StandardError; end
+
+  # Filter to transform ChatGPT data into HTML/CSS viewer
+  module Filter
+    def chatgpt(input, markdownify = true)
+      site = @context.registers[:site]
+      @context["conversation"] = input
+      @context["mdfy"] = markdownify
+
+      inclusion = site.liquid_renderer.file("chatgpt.html")
+      inclusion.parse(File.read(File.expand_path("chatgpt.html", __dir__)))
+
+      site.includes_load_paths.push(__dir__)
+      res = inclusion.render(@context)
+      site.includes_load_paths.pop
+
+      res
+    end
+  end
+
+  # Renders chatgpt.sass to /chatgpt.css
+  class StyleGenerator < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    def generate(site)
+      chatgpt_style = Jekyll::PageWithoutAFile.new(site, __dir__, "", "chatgpt.sass")
+      chatgpt_style.tap do |file|
+        colors_exists = site.pages.filter do |page|
+          page.name =~ /colors\.sass$/i
+        end.size
+        file.content = ""
+        file.content += "@import \"colors\"\n" if colors_exists
+        file.content += File.read(File.expand_path("chatgpt.sass", __dir__))
+      end
+      site.pages << chatgpt_style
+    end
+  end
+end
+
+Liquid::Template.register_filter(JekyllChatgpt::Filter)

data/sig/jekyll_chatgpt.rbs

@@ -0,0 +1,4 @@
+module JekyllChatgpt
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-chatgpt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pcouy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-10 00:00:00.000000000 Z
+dependencies: []
+description: Use OpenAI API JSON as data files and display branching conversations
+  on your website
+email:
+- contact@pierre-couy.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/chatgpt.html
+- lib/chatgpt.sass
+- lib/chatgpt_message.html
+- lib/jekyll-chatgpt.rb
+- lib/jekyll-chatgpt/version.rb
+- sig/jekyll_chatgpt.rbs
+homepage: https://github.com/pcouy/jekyll-chatgpt
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pcouy/jekyll-chatgpt
+  source_code_uri: https://github.com/pcouy/jekyll-chatgpt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.25
+signing_key:
+specification_version: 4
+summary: Display and navigate branching ChatGPT conversations
+test_files: []