🔨🔥 update plugin name

.editorconfig

@@ -9,5 +9,8 @@ indent_style = space
 indent_size = 4
 tab_width = 4
 
+[*.yml]
+indent_size = 2
+
 [*.md]
 trim_trailing_whitespace = false

.github/workflows/release.yml

@@ -27,6 +27,7 @@ on:
 env:
   GH_BOT_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
   GH_BOT_NAME: "GitHub Action"
+  ZIP_ARTIFACT: slides-extended.zip
 
 jobs:
   build:
@@ -130,7 +131,7 @@ jobs:
         mkdir tmp
         cp -r ./build/css ./build/dist ./build/plugin ./build/template distVersion.json tmp/
         cd tmp
-        zip -r ../${{ github.event.repository.name }}.zip *
+        zip -r ../${{ env.ZIP_ARTIFACT }} *
         cd ..
 
     # Create the release on github
@@ -153,7 +154,7 @@ jobs:
             --prerelease=${prerelease}
 
         gh release upload "${{ steps.build.outputs.version }}" --clobber \
-            ${{ github.event.repository.name }}.zip \
+            "./${{ env.ZIP_ARTIFACT }}" \
             './build/main.js#main.js' \
             './build/styles.css#styles.css' \
             './manifest.json' \

.gitignore

@@ -23,5 +23,5 @@ dist
 old
 examples/
 
-obsidian-slides-extended/
-obsidian-slides-extended.zip
+slides-extended/
+slides-extended.zip

.markdownlint.yaml

@@ -1,3 +1,7 @@
 MD007:
   indent: 4
 MD013: false
+MD033:
+  allowed_elements:
+    - img
+    - a

README.md

@@ -1,30 +1,55 @@
 # Obsidian Slides Extended
+![GitHub all releases](https://img.shields.io/github/downloads/ebullient/obsidian-slides-extended/total?color=success)
 
 🚧 Fork in progress, there will be some dust 🚧
 
 Docs, especially, are pretty borked. ;)
 
-<img src="https://raw.githubusercontent.com/ebullient/obsidian-slides-extended/main/imgs/demo.gif">
+<img src="https://raw.githubusercontent.com/ebullient/obsidian-slides-extended/main/imgs/demo.gif" alt="demo">
 
-Slides Extended is the perfect slide deck extension for <a href="https://obsidian.md">Obsidian</a>
+Slides Extended is the perfect slide deck extension for [Obsidian](https://obsidian.md)
 
 ## Features
+
 - Embed your notes into your slides
 - Live Preview while editing your slides
 - Themes allow you to change the appearance of your slides
 - Annotations allow you to change the style of your slides
 - Export slides as PDF Documents or as HTML Presentations
 - **Full support of the Obsidian Markdown Syntax**
 
+## Installation
+
+Since Obsidian Slides Extended is not yet an official community plugin, it requires manual installation or installation using BRAT (Bundled Resources Action Tools). Here's how you can do it:
+
+### Manual Installation
+
+1. Download the latest release from [GitHub](https://github.com/ebullient/obsidian-slides-extended/releases).
+2. In Obsidian, open your vault's root folder in your file explorer.
+3. Navigate to the `.obsidian/plugins` directory. If it doesn't exist, create it.
+4. Extract the contents of the downloaded `.zip` file into a new folder within the `plugins` directory. The folder name should be `slides-extended`.
+5. Restart Obsidian or reload your vault.
+6. Go to `Settings` > `Community Plugins` and make sure "Safe Mode" is turned off.
+7. Click on `Browse` under `Community Plugins`, find `Obsidian Slides Extended`, and enable it.
+
+### Installation Using BRAT
+
+If you prefer to use BRAT for plugin management:
+
+1. Ensure you have BRAT installed. If not, follow the [BRAT installation guide](https://github.com/TfTHacker/obsidian42-brat#readme).
+2. In Obsidian, open the command palette (`Ctrl/Cmd + P`) and search for "BRAT: Add a Beta Plugin".
+3. Enter `ebullient/obsidian-slides-extended` as the GitHub repository.
+4. BRAT will handle the installation. Once complete, restart or reload your vault for changes to take effect.
+
+Remember, as this plugin forks an existing project, there may be changes or improvements over time. Keep an eye on the [GitHub repository](https://github.com/ebullient/obsidian-slides-extended) for updates and information on future official community plugin status.
+
 ## Acknowledgements
 
 Matthäus worked on this plugin for a long time, and [announced that he was discontinuing](https://forum.obsidian.md/t/discontinued-advanced-slides-create-markdown-based-reveal-js-presentations-in-obsidian/28243) the plugin on the forum.
 
-This plugin was a huge undertaking. I'm just picking up where Matthäus left off. 
+This plugin was a huge undertaking. I'm just picking up where Matthäus left off.
 
---- 
+---
 
 - MIT licensed | Copyright © 2024 Erin Schnabel
 - MIT licensed | Copyright © 2021 Matthäus Szturc
-
-

docs/README.md

@@ -1,13 +1,11 @@
 ---
-title: "Slides Extended Documentation"
 description: ""
 ---
 # Create Awesome Presentations in Obsidian
 
+[Slides Extended](https://github.com/ebullient/obsidian-slides-extended) is an open source plugin for [Obsidian](https://obsidian.md/) that allows you to create [reveal.js](https://revealjs.com/) based presentations in Obsidian. With this tool anyone who is able to create a note in Obsidian can also create a beautiful presentation.
 
-[Slides Extended](https://github.com/ebullient/obsidian-slides-extended) is an open source plugin for [Obsidian](https://obsidian.md/) that allows you to create [reveal.js](https://revealjs.com/) based presentations in Obsidian. With this tool anyone who is able to create a note in Obsidian can also create a beautiful presentation. 
-
-> [!NOTE] 
+> [!NOTE]
 > We follow the philosophy of `convention over configuration`.
 > In most cases it is sufficient to simply write a Slide in **Obsidian Markdown syntax**.
 

docs/themes/README.md

@@ -22,7 +22,7 @@ Slides Extended comes with a varity of diffrent themes built in:
 - consult
 - mattropolis
 
-The source for these built in themes is found in `.obsidian/plugins/obsidian-slides-extended/dist/theme`
+The source for these built in themes is found in `.obsidian/plugins/slides-extended/dist/theme`
 
 To activate a theme simply add a theme property in the frontmatter section of your slides:
 
@@ -40,7 +40,7 @@ Open the settings for Slides Extended Plugin, and choose a folder to use as your
 - Name your theme uniquely. 
 - If you reference pre-packaged fonts or want to import from existing themes, use `/dist/theme/...` as the path.
 - The theme suggester will list all themes from your theme directory,
-  `.obsidian/plugins/obsidian-slides-extended/css` and `.obsidian/plugins/obsidian-slides-extended/dist/theme`.
+  `.obsidian/plugins/slides-extended/css` and `.obsidian/plugins/slides-extended/dist/theme`.
 
 **Example:** 
 

manifest-beta.json

@@ -1,5 +1,5 @@
 {
-  "id": "obsidian-slides-extended",
+  "id": "slides-extended",
   "name": "Slides Extended",
   "version": "2.0.0",
   "minAppVersion": "0.16.0",

manifest.json

@@ -1,5 +1,5 @@
 {
-  "id": "obsidian-slides-extended",
+  "id": "slides-extended",
   "name": "Slides Extended",
   "version": "2.0.0",
   "minAppVersion": "0.16.0",

package.json

@@ -1,5 +1,5 @@
 {
-    "name": "obsidian-slides-extended",
+    "name": "slides-extended",
     "version": "2.0.0",
     "description": "Create markdown-based presentations with reveal.js in Obsidian",
     "author": "Erin Schnabel",

src/advancedSlides-Distribution.ts

@@ -32,7 +32,7 @@ export class AdvancedSlidesDistribution {
 
     async update() {
         const version = this.plugin.manifest.version;
-        const downloadUrl = `https://github.com/ebullient/obsidian-slides-extended/releases/download/${version}/obsidian-slides-extended.zip`;
+        const downloadUrl = `https://github.com/ebullient/obsidian-slides-extended/releases/download/${version}/slides-extended.zip`;
         const response = await requestUrl(downloadUrl);
         if (response.status != 200) {
             console.error(`Failed to download ${downloadUrl}`);

src/obsidian/obsidianUtils.ts

@@ -40,7 +40,7 @@ export class ObsidianUtils implements ImageCollector {
         this.pluginDir = path.join(
             this.vaultDir,
             this.app.vault.configDir,
-            'plugins/obsidian-slides-extended/',
+            'plugins/slides-extended/',
         );
         this.distDir = path.join(this.pluginDir, 'dist/');
         this.exportDir = path.join(