Skip to content

Commit

Permalink
馃嵈 Unfork/Rename (less confusion)
Browse files Browse the repository at this point in the history
  • Loading branch information
ebullient committed Mar 18, 2024
1 parent ae1bee1 commit 6fcb46a
Show file tree
Hide file tree
Showing 27 changed files with 46 additions and 44 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Advanced Slides for Obsidian
# Obsidian Slides Extended

馃毀 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">

Advanced Slides is the perfect slide deck extension for <a href="https://obsidian.md">Obsidian</a>
Slides Extended is the perfect slide deck extension for <a href="https://obsidian.md">Obsidian</a>

## Features
- Embed your notes into your slides
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Advanced Slides Documentation"
title: "Slides Extended Documentation"
description: ""
---
# Create Awesome Presentations in Obsidian


[Advanced Slides](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]
> We follow the philosophy of `convention over configuration`.
Expand Down
2 changes: 1 addition & 1 deletion docs/credits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Credits"
description: "contributors and packages used by Advanced Slides"
description: "contributors and packages used by Slides Extended"
---


Expand Down
2 changes: 1 addition & 1 deletion docs/extend-syntax/charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: ""
weight: 14
---

Advanced Slides allows to add charts using [Obsidian Charts](https://charts.phibr0.de/) plugin syntax or [Reveal.js Charts](https://github.com/rajgoel/reveal.js-plugins/tree/master/chart#usage) syntax.
Slides Extended allows to add charts using [Obsidian Charts](https://charts.phibr0.de/) plugin syntax or [Reveal.js Charts](https://github.com/rajgoel/reveal.js-plugins/tree/master/chart#usage) syntax.

#### Obsidian Charts Example:

Expand Down
2 changes: 1 addition & 1 deletion docs/extend-syntax/inlineStyling.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ css: [css/layout.css,css/customFonts.css]
```

These files will be found relative to either the configured custom Theme Directory or
the Advanced Slides plugin folder.
the Slides Extended plugin folder.
2 changes: 1 addition & 1 deletion docs/extend-syntax/slideAnimation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: ""
weight: 15
---

Advanced Slides can automatically animate elements across slides. All you need to do is add `data-auto-animate` to two adjacent slide annotationsand Auto-Animate will animate all matching elements between the two.
Slides Extended can automatically animate elements across slides. All you need to do is add `data-auto-animate` to two adjacent slide annotationsand Auto-Animate will animate all matching elements between the two.

Here's a simple example to give you a better idea of how it can be used:

Expand Down
2 changes: 1 addition & 1 deletion docs/extend-syntax/speakerNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: ""
weight: 8
---

Advanced Slides comes with a speaker notes function which can be used to present per-slide notes in a speaker view.
Slides Extended comes with a speaker notes function which can be used to present per-slide notes in a speaker view.

To access the speaker view you have to open `Slide Preview` and click on the `Open in Browser` Button in the top right corner. Your Slide will open in your default web browser. Press the 禄S芦 key on your keyboard to open the notes window.

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ weight: 1
pre: "<i class='fa fa-wrench' style='margin-right:5px' ></i> "
---

The following steps are here to help you to install Advanced Slides Plugin for Obsidian. If you never installed a plugin at all, we strongly suggest you to read the guideline on Community Plugins. [Obsidian Documentation on Community Plugins](https://help.obsidian.md/Extending+Obsidian/Community+plugins).
The following steps are here to help you to install Slides Extended Plugin for Obsidian. If you never installed a plugin at all, we strongly suggest you to read the guideline on Community Plugins. [Obsidian Documentation on Community Plugins](https://help.obsidian.md/Extending+Obsidian/Community+plugins).

## With Community Plugins

* Search for `Advanced Slides` in Community Plugins and hit `install` and `enable`
* Search for `Slides Extended` in Community Plugins and hit `install` and `enable`

> [!WARNING]
> Advanced Slides will download the runtime to create & display Slide Presentations.
> Slides Extended will download the runtime to create & display Slide Presentations.
> Make sure that your VPN/Proxy allows https connections to `github.com`.
## Configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/learnMore.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 4
pre: "<i class='fa fa-leanpub' style='margin-right:5px' ></i> "
---

Learn more about the Advanced Slides from the following pages:
Learn more about the Slides Extended from the following pages:

### Advanced Slides Basics

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ weight: 2
pre: "<i class='fa fa-gears' style='margin-right:5px' ></i> "
---

The settings can be found under Advanced Slides Section inside Plugin Settings. The settings can be found by clicking the gear in the bottom left corner, or by hitting `Ctrl/Cmd-,`.
The settings can be found under Slides Extended Section inside Plugin Settings. The settings can be found by clicking the gear in the bottom left corner, or by hitting `Ctrl/Cmd-,`.

Most of them are fairly self-explanatory, but here are some notes that might be helpful.

<!--more-->

### Port

Define on which Port Advanced Slides should run. The default Port is `3000`.
Changing the port can be useful if you operate multiple vaults and both have Advanced Slides plugin installed.
Define on which Port Slides Extended should run. The default Port is `3000`.
Changing the port can be useful if you operate multiple vaults and both have Slides Extended plugin installed.

## First Steps

Expand Down
2 changes: 1 addition & 1 deletion docs/layout/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ alwaysopen: false
pre: "<i class='fa fa-list-alt' ></i> "
---

Advanced Slides provides a variety of components that simplify layouting of you slides:
Slides Extended provides a variety of components that simplify layouting of you slides:

{{%children style="h2" description="true"%}}
2 changes: 1 addition & 1 deletion docs/layout/grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Grid layouts drag-and-drop is used to size and position content of your slides.

### Basic Syntax

The following syntax is used to drag-and-drop a grid in Advanced Slides:
The following syntax is used to drag-and-drop a grid in Slides Extended:

<grid drag="width height" drop="x y">

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ alwaysopen: false
pre: "<i class='fa fa-plug' ></i> "
---

Advanced Slides comes with a varity of diffrent plugins built in:
Slides Extended comes with a varity of diffrent plugins built in:

- [Chalkboard](chalkboard.md)
- [Elapsed Time Bar](elapseTimeBar.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/chalkboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ The main use case in mind when implementing the plugin is classroom usage in whi
![Chalkboard](../images/chalkboard.gif)

> [!WARNING]
> To enable Chalkboard you have to enable the Plugin in Advanced Slides Settings
> To enable Chalkboard you have to enable the Plugin in Slides Extended Settings
2 changes: 1 addition & 1 deletion docs/plugins/elapseTimeBar.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ A plugin adding a progress bar based on the elapsed time, that helps you keeping
To set the time for presentation add a `timeForPresentation` property into your slides frontmatter with the time you want to present in seconds.

> [!WARNING]
> To enable Elapsed Time Bar you have to enable the Plugin in Advanced Slides Settings
> To enable Elapsed Time Bar you have to enable the Plugin in Slides Extended Settings
4 changes: 2 additions & 2 deletions docs/plugins/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ description: ""
weight: 1
---

A slideout menu plugin for Advanced Slides to quickly jump to any slide by title.
A slideout menu plugin for Slides Extended to quickly jump to any slide by title.

![Menu](../images/menu.gif)


> [!WARNING]
> To enable Menu you have to enable the Plugin in Advanced Slides Settings
> To enable Menu you have to enable the Plugin in Slides Extended Settings
2 changes: 1 addition & 1 deletion docs/plugins/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Press the `禄ESC芦` or `禄O芦` keys to toggle the overview mode on and off. Whil
![Overview](../images/overview.gif)

> [!WARNING]
> To enable Overview you have to enable the Plugin in Advanced Slides Settings
> To enable Overview you have to enable the Plugin in Slides Extended Settings
2 changes: 1 addition & 1 deletion docs/plugins/pointer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ weight: 5
A plugin that changes your mouse pointer into a laser pointer. To activate laser pointer press 'Q' Button

> [!WARNING]
> To enable Laser Pointer you have to enable the Plugin in Advanced Slides Settings
> To enable Laser Pointer you have to enable the Plugin in Slides Extended Settings
2 changes: 1 addition & 1 deletion docs/templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ alwaysopen: false
pre: "<i class='fa fa-code' ></i> "
---

Advanced Slides allows you to design individual slides based on slide templates. Each slide template can have a unique layout and structure that you can draw upon repeatedly over the presentation. Using slide templates makes creating presentations that use different layout formats across different slides easy and fast. Also, slide templates reduce redundant code (aka boilerplate code) in your md presentation document.
Slides Extended allows you to design individual slides based on slide templates. Each slide template can have a unique layout and structure that you can draw upon repeatedly over the presentation. Using slide templates makes creating presentations that use different layout formats across different slides easy and fast. Also, slide templates reduce redundant code (aka boilerplate code) in your md presentation document.

### Example: Using a simple slide template

Expand Down
8 changes: 4 additions & 4 deletions docs/themes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ alwaysopen: false
pre: "<i class='fa fa-paint-brush' ></i> "
---

Advanced Slides comes with a varity of diffrent themes built in:
Slides Extended comes with a varity of diffrent themes built in:

- black (default)
- white
Expand Down Expand Up @@ -35,7 +35,7 @@ To activate a theme simply add a theme property in the frontmatter section of yo

If you want to use a custom theme you can do that, but please keep your themes in your vault.

Open the settings for Advanced Slides Plugin, and choose a folder to use as your "Theme Directory".
Open the settings for Slides Extended Plugin, and choose a folder to use as your "Theme Directory".

- Name your theme uniquely.
- If you reference pre-packaged fonts or want to import from existing themes, use `/dist/theme/...` as the path.
Expand All @@ -47,7 +47,7 @@ Open the settings for Advanced Slides Plugin, and choose a folder to use as your
If you create a directory in your vault called `assets/themes`, and create a
CSS file called **my-theme.css** in that directory:

1. Open settings for Advanced Slides Plugin, and choose `assets/themes` as the "Theme Directory"
1. Open settings for Slides Extended Plugin, and choose `assets/themes` as the "Theme Directory"
2. You should be able to select `my-theme.css` as the default theme in slide settings (suggester)
3. Alternatively, you can specify the theme as a property in your slides markdown file:

Expand Down Expand Up @@ -75,7 +75,7 @@ To activate a highlight theme simply add a highlightTheme property in the frontm

---

By default advanced slides comes with a variety of different highlight themes:
By default Slides Extended comes with a variety of different highlight themes:

- zenburn (default)
- monokai
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ markdown:
smartypants: false
```

Other marked options exist, but should not be used with the Advanced Slides plugin.
Other marked options exist, but should not be used with the Slides Extended plugin.

10 changes: 5 additions & 5 deletions src/advancedSlides-Plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ export class AdvancedSlidesPlugin extends Plugin {
const distribution = new AdvancedSlidesDistribution(this);

console.log(
'Advanced Slides v%s, needsReload=%s',
'Slides Extended v%s, needsReload=%s',
version,
distribution.isOutdated(),
);
if (distribution.isOutdated()) {
await distribution.update();
console.log('Advanced Slides updated to v%s', version);
console.log('Slides Extended updated to v%s', version);
}

try {
Expand Down Expand Up @@ -112,7 +112,7 @@ export class AdvancedSlidesPlugin extends Plugin {
this.obsidianUtils.markdownProcessor.postProcess,
);
} catch (err) {
console.debug('Advanced Slides caught an error', err);
console.debug('Slides Extended caught an error', err);
}
}

Expand Down Expand Up @@ -240,7 +240,7 @@ export class AdvancedSlidesPlugin extends Plugin {
}

async onunload() {
console.debug('unloading Advanced Slides');
console.debug('unloading Slides Extended');
await this.stopServer();

this.app.workspace
Expand All @@ -258,7 +258,7 @@ export class AdvancedSlidesPlugin extends Plugin {

async saveSettings() {
await this.saveData(this.settings);
console.debug('Advanced Slides: settings saved');
console.debug('Slides Extended: settings saved');

await this.stopServer();
this.obsidianUtils = new ObsidianUtils(this.app, this.settings);
Expand Down
2 changes: 1 addition & 1 deletion src/advancedSlides-SettingTab.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ export class AdvancedSlidesSettingTab extends PluginSettingTab {
new Setting(containerEl)
.setName('Export directory')
.setDesc(
'Specify the directory where Advanced Slides should export presentations.',
'Specify the directory where Slides Extended should export presentations.',
)
.addSearch(cb => {
new FolderSuggest(this.app, cb.inputEl);
Expand Down
8 changes: 4 additions & 4 deletions src/reveal/revealServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,15 +113,15 @@ export class RevealServer {
async start() {
if (this.running) {
console.debug(
'Advanced Slides server is already running',
'Slides Extended server is already running',
this._server.listeningOrigin,
);
return;
}
try {
await this._server.listen({ host: '127.0.0.1', port: this._port });
console.info(
'Advanced Slides is ready to go.',
'Slides Extended is ready to go.',
this._server.listeningOrigin,
);
} catch (err) {
Expand All @@ -134,10 +134,10 @@ export class RevealServer {

async stop() {
if (this.running) {
console.log('stopping Advanced Slides server', this.running);
console.log('stopping Slides Extended server', this.running);
await this._server.close();
} else {
console.debug('Advanced Slides server is not running');
console.debug('Slides Extended server is not running');
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/template/reveal.html
Original file line number Diff line number Diff line change
Expand Up @@ -263,5 +263,5 @@
</script>
</body>

<!-- created with {{! ignore me }}Advanced Slides -->
<!-- created with {{! ignore me }}Slides Extended -->
</html>

0 comments on commit 6fcb46a

Please sign in to comment.