Merge pull request #51 from Aetherinox/main

v1.6.4: Merge stable and beta branches

Author: Aetherinox

.github/changelog-configuration.json

@@ -1,12 +1,12 @@
 {
     "categories": [
         {
-            "title": "\n\n<br>\n\n#### 🚀 Features",
-            "labels": [ "kind/feature", "feature", "feat" ]
+            "title": "\n\n<br>\n\n#### 🪛 Continuous integration",
+            "labels": [ "kind/ci", "ci" ]
         },
         {
-            "title": "\n\n<br>\n\nn#### ✨ Optimizations",
-            "labels": [ "kind/perf", "optimization", "perf", "optimize" ]
+            "title": "\n\n<br>\n\n#### 🚀 Features",
+            "labels": [ "kind/feature", "feature", "feat" ]
         },
         {
             "title": "\n\n<br>\n\n#### 🐛 Bugfixes",
@@ -17,16 +17,8 @@
             "labels": [ "kind/chore", "change", "chore" ]
         },
         {
-            "title": "\n\n<br>\n\n#### ✏️ Docs",
-            "labels": [ "kind/docs", "doc", "docs", "wiki" ]
-        },
-        {
-            "title": "\n\n<br>\n\n#### 🧪 Tests",
-            "labels": [ "kind/test", "test" ]
-        },
-        {
-            "title": "\n\n<br>\n\n#### 📦 Build & Dependencies",
-            "labels": [ "kind/build", "build", "dependency", "package" ]
+            "title": "\n\n<br>\n\nn#### ✨ Optimizations",
+            "labels": [ "kind/perf", "optimization", "perf", "optimize" ]
         },
         {
             "title": "\n\n<br>\n\n#### 🚨 Security ",
@@ -47,6 +39,18 @@
         {
             "title": "\n\n<br>\n\n#### ⛔ Removed",
             "labels": [ "kind/remove", "remove" ]
+        },
+        {
+            "title": "\n\n<br>\n\n#### 📦 Build & Dependencies",
+            "labels": [ "kind/build", "build", "dependency", "dep", "package" ]
+        },
+        {
+            "title": "\n\n<br>\n\n#### ✏️ Docs",
+            "labels": [ "kind/docs", "doc", "docs", "wiki" ]
+        },
+        {
+            "title": "\n\n<br>\n\n#### 🧪 Tests & Demo Vault",
+            "labels": [ "kind/test", "test", "tests", "vault" ]
         }
     ],
     "sort": "ASC",
@@ -65,11 +69,11 @@
       ],
     "label_extractor": [
         {
-        "pattern": "^(build|ci|change|chore|doc|docs|wiki||remove|deprecate|security|dependency|package|feat|feature|fix|bug|perf|optimize|optimization|refactor|revert|style|test):(.*)",
+        "pattern": "^(build|ci|change|chore|doc|docs|wiki|remove|deprecate|security|dependency|dep|package|feat|feature|fix|bug|perf|optimize|optimization|refactor|revert|style|test|tests|vault):(.*)",
         "target": "$1"
         },
         {
-        "pattern": "^(build|ci|change|chore|doc|docs|wiki||remove|deprecate|security|dependency|package|feat|feature|fix|bug|perf|optimize|optimization|refactor|revert|style|test){1}(\\([\\w\\-\\.]+\\))?(!)?:(.*)",
+        "pattern": "^(build|ci|change|chore|doc|docs|wiki|remove|deprecate|security|dependency|dep|package|feat|feature|fix|bug|perf|optimize|optimization|refactor|revert|style|test|tests|vault){1}(\\([\\w\\-\\.]+\\))?(!)?:(.*)",
         "target": "$1"
         }
     ],

.github/workflows/documentation.yml

@@ -40,7 +40,9 @@ jobs:
     permissions:
       contents: write
       pages: write
-    
+    environment:
+      name: Orion
+      
     steps:
       - name: "Checkout"
         uses: actions/checkout@v4
@@ -73,5 +75,5 @@ jobs:
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
-          personal_token: ${{ secrets.ADMINSERV_TOKEN }}
+          personal_token: ${{ secrets.ADMINSERV_TOKEN_CL }}
           publish_dir: ./docs/site

.github/workflows/pr-issues-status.yml

@@ -557,9 +557,9 @@ jobs:
 
           <sub>I am a bot reaching out to you with an automated response.</sub>
 
-        stale-issue-label: 'Status ↯ Stale'
-        close-issue-label: 'Status ↯ Autoclosed'
-        exempt-issue-labels: 'feature,Type ⇴ Feature,bug,Type ⇴ Bug'
+        stale-issue-label: 'Status 𐄂 Stale'
+        close-issue-label: 'Status 𐄂 '
+        exempt-issue-labels: 'feature,Type ◦ Feature,bug,Type ◦ Bug'
         days-before-stale: 30
         days-before-close: 7
         days-before-pr-stale: -1

.github/workflows/release-npm.yml

@@ -169,6 +169,8 @@ jobs:
                 tag: ${{ env.PACKAGE_VERSION }}
                 tag_exists_error: false
                 message: "Latest release"
+                gpg_private_key: ${{ secrets.ADMINSERV_GPG_KEY_ASC }}
+                gpg_passphrase: ${{ secrets.ADMINSERV_GPG_PASSPHRASE }}
 
             # ---------------------------------------------------------------------------------------
             #   [ Tag ]: Confirm

README.md

@@ -47,32 +47,32 @@ The following is an outline of what Gistr can do for you:
 <br />
 
 **Functionality**:
-- Gistr now includes an integrated browser feture which allows you to embed any website into your notes, including Github and Opengist.
-  - This can be used for embedding gists  containing mermaid graphs
-  - Feature allows you to not only view the website in your notes, but also sign into websites such as Github / Opengist and make edits.
-  - Can be activated with `raw` property
-  - `raw` property supports the ability to specify additional properties:
-    - `zoom`
-    - `height`
-    - `css`
+- Two modes for embedding: **Codeblock mode** and **Website mode**.
+- (**Website Mode**): Embed any website into your Obsidian notes. Fully functioning browser with ability to sign in to accounts and navigate.
+  - Can be used for Github / Gist mermaid graphs
+  - Activated with [raw](https://aetherinox.github.io/obsidian-gistr/usage/properties/#raw) property
+  - [raw](https://aetherinox.github.io/obsidian-gistr/usage/properties/#raw) property supports the ability to specify additional properties:
+    - [zoom](https://aetherinox.github.io/obsidian-gistr/usage/properties/#property-zoom): change the size of the website
+    - [height](https://aetherinox.github.io/obsidian-gistr/usage/properties/#property-height): change the height of the website frame
+    - [css](https://aetherinox.github.io/obsidian-gistr/usage/properties/#property-css): override existing CSS on the embedded website
 - Save notes from Obsidian as public or secret gists
-  - Choose when you want to save a gist, or enable autosave to track changes
-  - Requires Github [Personal Access Token](https://github.com/settings/tokens?type=beta) (free). Open Gistr settings in Obsidian to configure.
-- Line numbering
-- Open embedded Github Gist or Opengist snippets from your notes in your browser
-- Filter out specific snippets from a gist which contain multiple files
+  - Manual and autosave settings available
+  - Requires Github [Personal Access Token](https://github.com/settings/tokens?type=beta) (free).
+    - [Click here to read setup instructions](https://aetherinox.github.io/obsidian-gistr/settings/github/)
+- Line numbering & syntax highlighting
+- Open embedded Github Gist or Opengist snippets from your notes in your device browser
+- Filter out gists that contain more than one file
 - Enable / Disable text wrapping and horizontal scrollbar
-- Auto-refresh any edits to your settings in reading mode
-- Complete customization, including changing the keyword that triggers a codeblock to show gists.
+- Fast performance and caching
+- Complete customization for almost every aspect of the plugin and the sites you embed
 
 <br />
 
 **Themes**:
-- Includes **Light** & **Dark** mode for both services
-- Ability to customize individual colors
-- CSS stylesheet override
+- Includes **Light** & **Dark** themes for Github and Opengist
+- Customize individual colors through Gistr settings, or use CSS stylesheet override
 - Thin and customizable scrollbar
-- Force theme on each individual gist paste
+- Force amy theme on each individual gist paste
 
 <br />
 

docs/docs/changelog.md

@@ -7,15 +7,31 @@ tags:
 
 ![Version](https://img.shields.io/github/v/tag/Aetherinox/obsidian-gistr?logo=GitHub&label=version&color=ba5225) ![Downloads](https://img.shields.io/github/downloads/Aetherinox/obsidian-gistr/total) ![Repo Size](https://img.shields.io/github/repo-size/Aetherinox/obsidian-gistr?label=size&color=59702a) ![Last Commit)](https://img.shields.io/github/last-commit/Aetherinox/obsidian-gistr?color=b43bcc)
 
+### <!-- md:version stable- --> 1.6.4 <small>April 02, 2024</small> { id="1.6.4" }
+
+- `feat`: add `gistr-web` codeblock as alternative to `raw: true`
+- `change`: remove spacer from documentation button in Gistr settings
+- `chore`: clean up developer prints
+- `chore`: give integrated browser unique id as to not conflict with other plugins
+- `fix`: report latest version in settings tab with alternative vars
+- `fix`: update checker getting stuck when it cannot contact the github branch
+- `tests`: bump demo vault 1.6.4
+- `dep`: update @types/node 20.11.30 -> 20.12.3
+- `build`: bump version v1.6.4
+
 ### <!-- md:version stable- --> 1.6.3 <small>April 01, 2024</small> { id="1.6.3" }
 
 - `feat`: added property `css` for **raw mode**
-- `change`: added documentation link to Gistr settings support tab
+- `change`: added documentation button to Gistr settings support tab
 - `change`: uuid for gists now generated by in-house method instead of nanoid
+- `refactor`: major clean up of code, old dependency remnants, and tidy up code
+- `perf`: further enhanced performance times and how caching is managed for codeblocks embedded in a note
+- `change`: prep-work for next major release and new features coming out, including Github repo support
 - `dep`: update rollup 3.29.3 -> 4.13.2
 - `dep`: added `@rollup/plugin-replace`
 - `remove`: `rollup-plugin-define`
 - `remove`: `nanoid`
+- `build`: github bot @AdminServ now verified
 
 ### <!-- md:version stable- --> 1.6.2 <small>March 31, 2024</small> { id="1.6.2" }
 

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "gistr",
   "name": "Gistr",
-  "version": "1.6.2",
+  "version": "1.6.4",
   "minAppVersion": "1.0.0",
   "description": "Integrate Opengist and Github gists into your notes, allowing you to create, update, and share between your notes and gist services",
   "author": "Aetherinox",

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "gistr",
-  "version": "1.6.2",
+  "version": "1.6.4",
   "description": "Integrate Opengist and Github gists into your notes, allowing you to create, update, and share between your notes and gist services",
   "main": "main.js",
   "repository": {
@@ -35,7 +35,7 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/chrome": "^0.0.263",
-    "@types/node": "^20.11.30",
+    "@types/node": "^20.12.3",
     "@types/semver": "^7.5.8",
     "@types/uuid": "^9.0.8",
     "electron": "^29.1.6",

package.json

@@ -41,6 +41,6 @@ export const GithubCSS =
 export const LeafButton_Refresh =
 {
 	id:     "GISTR",
-	icon:   'gistr-github-refresh',
-	name:   "Refresh Gistr Codeblocks",
+	icon:   'gistr-plugin-refresh',
+	name:   "Refresh Gistr Plugin",
 }