first commit

This commit is contained in:
CrazyJasonwell
2026-07-23 20:36:13 +08:00
commit 513b68be8c
7915 changed files with 2642530 additions and 0 deletions
+18
View File
@@ -0,0 +1,18 @@
---
title: Getting Started
nav_order: 2
has_children: true
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Getting Started
- [Setup Vault](11.SetupVault.md)
- [Configuration](12.Configuration.md)
- [Marp Syntax](13.MarpSyntax.md)
- [First Deck](14.FirstDeck.md)
+20
View File
@@ -0,0 +1,20 @@
---
title: Setup Vault
parent: Getting Started
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Setup Vault
Obsidian is a powerful note-taking app that allows users to create and organize their notes and ideas in a highly customizable and intuitive interface. Setting up Obsidian for optimal use requires a few key steps to ensure that you can get the most out of the app's features and capabilities.
The first step in setting up Obsidian is to create a vault, which is essentially a container for all of your notes and files. This can be done by simply creating a new folder on your computer and selecting it as your vault location within the app's settings. Once your vault is set up, you can start creating notes and organizing them into folders and subfolders as needed.
Next, it's important to customize Obsidian's settings to fit your workflow and preferences. This includes adjusting things like the default font and theme, enabling or disabling various plugins, and configuring hotkeys and other shortcuts for quick access to frequently used features.
![Vault Settings](pictures/VaultSettings.gif)
- Relative path to files
- Not use Wikilinks
- Detect all file extension
+49
View File
@@ -0,0 +1,49 @@
---
title: Configuration
parent: Getting Started
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Configuration
![Settings](pictures/Settings.png)
## Chrome Path
Sets the custom path for Chrome or Chromium-based browser to export PDF, PPTX, and image. If it\'s empty, Marp will find out the installed Google Chrome / Chromium / Microsoft Edge.
## Theme Path
Local paths to additional [theme CSS](https://marpit.marp.app/theme-css) for Marp core and Marpit framework. The rule for paths is following Markdown: Styles.
## Export Path
Specifies the user-defined path for exporting PDF, PPTX, and images. If left empty, Marp will export them in the same folder as the note. It's important to note that the export path has no impact on HTML exports.
## Enable HTML
Enable all HTML elements in Marp Markdown. Please Attention when you enable!!!
## Math Typesettings
Controls math syntax and the default library for rendering math in Marp Core. A using library can override by math global directive in Markdown.
## HTML Export
**This is an EXPERIMENTAL feature**
Controls HTML library for eporting HTML File in Marp Cli. bespoke.js is experimental
## Sync Preview
**This is an EXPERIMENTAL feature**
Sync the slide preview with the editor cursor
## Markdown It Plugins
**This is an EXPERIMENTAL feature**
Enable the [Markdown It Plugins](30.Markdown-it-Plugins.md) (Mark, Containers, Kroki)
+33
View File
@@ -0,0 +1,33 @@
---
title: Marp Syntax
parent: Getting Started
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Marp Syntax
Here are some of the key elements of Marp's syntax, along with references to their official documentation:
- Markdown: Marp uses standard Markdown syntax for formatting text, including headings, lists, links, images, and more. For a comprehensive guide to Markdown syntax, see the official documentation: https://www.markdownguide.org/basic-syntax/
- Slide separators: To create a new slide in Marp, you simply insert three hyphens (---) between two lines of text. You can also use three equal signs (===) to create a separator between slides. For more information on slide separators, see: https://marpit.marp.app/markdown#slide-separators
- Code blocks: Marp supports syntax highlighting for code blocks, which can be useful for technical presentations. To create a code block, simply indent the text by four spaces, or use triple backticks (`) to enclose the code. For more information on code blocks, see: https://marpit.marp.app/markdown#code-blocks
- Themes: Marp comes with a range of built-in themes for styling your presentations. You can also create your own custom themes using CSS. To apply a theme to your presentation, simply add a theme directive to the first line of your Markdown file. For more information on themes, see: https://marpit.marp.app/theme-css
- Speaker notes: Marp allows you to add speaker notes to your presentation, which are visible only to the presenter. To create speaker notes, simply add text inside the square brackets ([ ]) following a slide separator. For more information on speaker notes, see: https://marpit.marp.app/markdown#speaker-notes
These are just a few examples of Marp's syntax. For more detailed information and examples, you can refer to Marp's official documentation: https://marpit.marp.app/
## Auto-scaling features
- **Fitting header**: Get bigger heading that fit onto the slide by # `<!--fit-->`.
- Auto-shrink the **code block**
- Auto-shrink **KaTeX block**
![Auto Scaling](pictures/AutoScale.gif)
[reference](https://github.com/marp-team/marp-core#auto-scaling-features)
+26
View File
@@ -0,0 +1,26 @@
---
title: First Deck
parent: Getting Started
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# First Deck
When creating a presentation, it's important to plan out your content and structure in advance to ensure that your message is clear and engaging. One way to do this is to break your presentation into a series of slides that each convey a specific point or idea.
![Alt text](pictures/FirstDeck.gif)
Here are some tips for creating effective slides in Marp:
1. First, start by writing your first slide. This slide should introduce your topic and grab your audience's attention. Keep it concise and to the point, and consider using a bold or eye-catching font to make it stand out.
2. Next, preview your slides to get a sense of the overall flow and structure of your presentation. Marp allows you to view your slides in real-time as you write, so you can see how each slide looks as you go.
3. For your second slide, consider adding a picture to help illustrate your point. Marp allows you to easily add images to your slides, and you can even set them as the background for your slide for added impact.
4. When designing your slides, don't forget to add a footer that includes your name, the date, and the title of your presentation. This helps to give your presentation a professional look and feel, and also makes it easier for your audience to keep track of where they are in the presentation.
5. Finally, consider changing the theme of your presentation to give it a unique and polished look. Marp comes with a range of built-in themes to choose from, or you can create your own custom theme using CSS for a truly personalized touch.
By following these tips and using Marp's simple and intuitive syntax, you can create engaging and effective presentations that captivate your audience and convey your message with clarity and impact.
+14
View File
@@ -0,0 +1,14 @@
---
title: Features
nav_order: 3
has_children: true
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Features
- [Slides Preview](21.SlidesPreview.md)
- [Slides Export](22.SlidesExport.md)
- [Slides Custom Theme](23.SlidesCustomTheme.md)
- [Presenting](24.Presenting.md)
+15
View File
@@ -0,0 +1,15 @@
---
title: Slides Preview
parent: Features
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Preview Slides
Marp for Obsidian lets you preview your Marp Markdown in real time, allowing you to instantly view changes as you make them! With this feature, you can quickly refine and perfect your Markdown documents.
![Slide Preview](pictures/DeckPreview.gif)
The preview of the content of active Markdow editor, use the ribbon icon or execute command from the Command Palette (<kbd>Ctrl/Cmd+P</kbd> + 'Slide Preview')
+23
View File
@@ -0,0 +1,23 @@
---
title: Slides Export
parent: Features
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Export slide deck (html, pdf, pptx, img)
We have integrated [Marp CLI](https://github.com/marp-team/marp-cli/) to export your deck into several formats.
To export the content of active Markdown editor execute command from the Command Palette (<kbd>Ctrl/Cmd+P</kbd>).
![Alt text](pictures/ExportPDF.gif)
## Supported file types
- **HTML** export
- **PDF** with or without annotation
- **PPTX** PowerPoint document
- **PNG** One file for every slide
> ⚠️ Export except HTML requires to install any one of [Google Chrome](https://www.google.com/chrome/), [Chromium](https://www.chromium.org/), or [Microsoft Edge](https://www.microsoft.com/edge). You may also specify the custom path for Chrome / Chromium-based browser by preference `CHEROME_PATH`.
+43
View File
@@ -0,0 +1,43 @@
---
title: Slides Custom Themes
parent: Features
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Use custom theme CSS
You can register and use [custom theme CSS for Marpit](https://marpit.marp.app/theme-css) / [Marp Core](https://github.com/marp-team/marp-core/tree/main/themes#readme) by setting `ThemePath`, that includes relative paths to local files in the current vault.
The registered theme can use by specifying theme name in [`theme` global directive](https://marpit.marp.app/directives?id=theme).
![Theme](pictures/Theme.gif)
Theme.css:
```css
/* @theme your-theme */
@import 'default';
section {
background: #fc9;
}
```
Slides.md:
```markdown
---
theme: your-theme
---
# Use your own theme
---
# Second Slide
```
Markdown preview will reload updated theme CSS automatically when you edited the registered local CSS file.
---
+12
View File
@@ -0,0 +1,12 @@
---
title: Presenting
parent: Features
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Presenting
Marp for Obsidian lets you present your Marp Markdown.
![Alt text](pictures/Presenting.gif)
+28
View File
@@ -0,0 +1,28 @@
---
title: Markdown-It Plugins
nav_order: 4
has_children: true
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Markdown-It
Markdown-it is a powerful and flexible Markdown parser that allows you to convert Markdown syntax into HTML. It’s widely used for rendering Markdown content on websites, blogs, and documentation.
## Markdown-it Plugins
Markdown-it supports community-written plugins. The Plugins can be loaded like this:
```js
const md = markdownit
.use(plugin1)
.use(plugin2, opts, ...)
.use(plugin3);
```
## Marp Slides Markdown-It Plugins
- [Mark](31.Markdown-it-Mark.md)
- [Containers](32.Markdown-it-Conteiners.md)
- [Kroki](33.Markdown-it-Kroki.md)
+30
View File
@@ -0,0 +1,30 @@
---
title: Markdown-It Mark
parent: Markdown-It Plugins
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Markdown-It Mark
Markup uses the same conditions as CommonMark [emphasis](http://spec.commonmark.org/0.15/#emphasis-and-strong-emphasis).
`==marked==` => `<mark>inserted</mark>`
## Sample
```markdown
---
# Text Highlights
**[markdown-it-mark](https://github.com/markdown-it/markdown-it-mark)**
This is ==marked== text
---
```
![alt text](pictures/plugin-mark.png)
## References
- [markdown-it-mark](https://github.com/markdown-it/markdown-it-mark)
+59
View File
@@ -0,0 +1,59 @@
---
title: Markdown-It Conteiners
parent: Markdown-It Plugins
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Markdown-It Container
With this plugin you can create block containers like:
```markdown
::: container
*here be dragons*
:::
```
.... and specify how they should be rendered. If no renderer defined, `<div>` with
container name class will be created:
```html
<div class="container">
<em>here be dragons</em>
</div>
```
## Sample
```markdown
---
<!-- _class: box-flex -->
# Columns Containers
**[markdown-it-container](https://github.com/markdown-it/markdown-it-container)**
::: container
## Colum 1
text dadadas text text text text text text text text text text
:::
::: container
## Colum 2
text
:::
---
```
![alt text](pictures/plugin-container.png)
## References
- [markdown-it-container](https://github.com/markdown-it/markdown-it-container)
+52
View File
@@ -0,0 +1,52 @@
---
title: Markdown-It Kroki
parent: Markdown-It Plugins
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# markdown-it-kroki
> This library was designed to embed [Kroki.io](https://kroki.io/) diagram into [Marp](https://marp.app/) slide decks!!
This library is a plugin for markdown-it to embed figure created by textual syntax.
To use this package, you can embed **Software Diagram** (like UML) written by **code** in Marp slide decks.
## Sample
```
@startuml
left to right direction
actor Guest as g
package Professional {
actor Chef as c
actor "Food Critic" as fc
}
package Restaurant {
usecase "Eat Food" as UC1
usecase "Pay for Food" as UC2
usecase "Drink" as UC3
usecase "Review" as UC4
}
fc --> UC4
g --> UC1
g --> UC2
g --> UC3
@enduml
```
![alt text](pictures/plugin-kroki.png)
If you want to write diagrams, you can use various syntaxes (such as [PlantUML](https://plantuml.com/) or [Mermaid](https://mermaid-js.github.io/mermaid/#/)) within fenced code blocks.
> [!NOTE]
> This package depends on [Kroki.io](https://kroki.io).
> If you want to know which **diagram languages are supported**,
> please check the official website at [https://kroki.io/](https://kroki.io/).
## References
- [markdown-it-kroki](https://github.com/kazumatu981/markdown-it-kroki)
+27
View File
@@ -0,0 +1,27 @@
---
title: Examples
nav_order: 5
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Examples
## Setup Vault
- clone and open
- install marp community plugin
- configure obsidian
- configure theme
![Vault Settings](pictures/VaultSettings.gif)
## Example Vault
We have created a dedicated Obsidian vault for testing the plugin and Marp presentations. It is a great way to explore the full potential of these tool without impacting your main vault or risking any data loss or corruption. By using a separate vault for testing, you can experiment freely and make changes without worrying about affecting your existing notes and files.
To set up a lab Obsidian vault, you can clone the [plugin repository](https://github.com/samuele-cozzi/obsidian-marp-slides) and open the vault folder with obsidian.
![Examples](pictures/Examples.gif)
One area where the lab vault can be especially useful is in testing Marp presentations. Marp is an open-source tool that allows users to create professional-looking presentations using simple Markdown syntax. By building and testing Marp presentations within your lab Obsidian vault, you can experiment with different formatting options and see how your presentations look and feel in a safe and isolated environment.
+314
View File
@@ -0,0 +1,314 @@
---
title: Changelog
nav_order: 99
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Changelog
## [0.45.6](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.45.5...0.45.6) (2024-05-08)
### Bug Fixes
* engine resolved on ubuntu ([8fe76a7](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/8fe76a7adb2605d8ee3d088265d47fcbcc3d37cd))
* engine resolved on ubuntu ([897fa14](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/897fa14d33cc4ce3780d350dcac74917d9e53d33))
* Merge pull request [#159](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/159) from samuele-cozzi:156-the-specified-engine-cannot-be-resolved ([8fe76a7](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/8fe76a7adb2605d8ee3d088265d47fcbcc3d37cd))
## [0.45.5](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.45.4...0.45.5) (2024-03-09)
### Bug Fixes
* enhancement of the doc ([235483a](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/235483a2ed8c1fa1fa7110a7dc4e53e3ca30d4b3))
## [0.45.4](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.45.3...0.45.4) (2024-03-09)
### Bug Fixes
* lib not found ([f3666a4](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/f3666a453fef14dc0f128d0f54da06b128d7126d))
## [0.45.3](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.45.2...0.45.3) (2024-03-09)
### Bug Fixes
* dependencies of markdown-it plugins ([657c0aa](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/657c0aa672b370e4daea7c16a229fbc6de9f0f89))
## [0.45.2](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.45.1...0.45.2) (2024-03-09)
### Bug Fixes
* file is null ([d53c34e](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/d53c34e37efebe04858e36484815966437012918))
## [0.45.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.45.0...0.45.1) (2024-03-09)
### Bug Fixes
* file parent null ([8140a6a](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/8140a6a16199ce32ddadf8559a8bf8d466b5c2fc))
## [0.45.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.44.0...0.45.0) (2024-03-09)
### Features
* Merge pull request [#144](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/144) from samuele-cozzi:134-highlighting-missing ([50c4453](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/50c4453f1d2c55f52ebbf0b10417fcb01ae189d2))
## [0.44.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.43.0...0.44.0) (2024-01-31)
### Features
* Merge pull request [#140](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/140) from samuele-cozzi:139-external-images-dont-appear-in-deck-preview ([43e829f](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/43e829fe4ed98ee504bcb5b3778f9815a8a91489))
## [0.43.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.42.2...0.43.0) (2024-01-20)
### Features
* mobile app alpha ([6d5f50c](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/6d5f50c1f25f1a9cf35247def50c23c581b0b3f0))
## [0.42.2](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.42.1...0.42.2) (2024-01-18)
### Bug Fixes
* issues 129, 130 suggestion ([57d4ce5](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/57d4ce5fd4d32bc5b3a780e786a71e473f7695ec))
## [0.42.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.42.0...0.42.1) (2024-01-07)
### Bug Fixes
* error Line selection listener ([d37a358](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/d37a35856e22c7921162067c665eec0e63beae92))
* Merge pull request [#131](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/131) from samuele-cozzi:130-v0420-breaks-other-plugins-suggestion-completion ([d37a358](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/d37a35856e22c7921162067c665eec0e63beae92))
## [0.42.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.41.0...0.42.0) (2023-12-24)
### Features
* Merge pull request [#126](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/126) from samuele-cozzi:124-synchronize-scrolling-of-markdown-editing-view-and-slide-preview-view ([9ebc658](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/9ebc658222b558806e7e5d55b80fe4a3ed872d17))
* sync code editor and preview ([9ebc658](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/9ebc658222b558806e7e5d55b80fe4a3ed872d17))
## [0.41.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.40.0...0.41.0) (2023-11-22)
### Features
* Merge pull request [#121](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/121) from samuele-cozzi:116-how-to-export-the-powerpoint-document ([16adf12](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/16adf120d5640d65628f8107ce9466d706ef66f5))
* shortcut for export pptx ([16adf12](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/16adf120d5640d65628f8107ce9466d706ef66f5))
* shortcut for export pptx ([5efbe82](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/5efbe8266ba4d94cd43b87c328c9e59c576db717))
## [0.40.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.39.0...0.40.0) (2023-11-22)
### Features
* documentation tree ([d66318e](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/d66318e1357b930dbd6fa647f2cf6e2b15588c5c))
## [0.39.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.38.1...0.39.0) (2023-10-31)
### Features
* release new version ([9f8a6e1](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/9f8a6e179314dc87da59985e9ae58bdb8287c050))
## [0.38.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.38.0...0.38.1) (2023-10-27)
### Bug Fixes
* enable advanced html ([88a95ae](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/88a95aefb072f0f9963779b962f5f70a42797e47))
* Merge pull request [#109](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/109) from samuele-cozzi/108-html-enhanced-view ([88a95ae](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/88a95aefb072f0f9963779b962f5f70a42797e47))
## [0.38.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.37.1...0.38.0) (2023-09-10)
### Features
* presents slides ([515ce27](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/515ce27df87d7316c8b27ed3566d4c366b51a727))
## [0.37.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.37.0...0.37.1) (2023-08-06)
### Bug Fixes
* Update README.md ([5ea42d9](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/5ea42d93096d62dd017fb98d36d27bbf4b01a300))
## [0.37.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.36.1...0.37.0) (2023-06-24)
### Features
* advanced html export ([14523f9](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/14523f9fbf642674a56f154c3c1f47b271972eb7))
* advanced html export ([41e77f3](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/41e77f310dbf5ca04f9f915df9b9dc9fdc4d14ba))
* Merge pull request [#94](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/94) from samuele-cozzi:feature/advanced-html-export ([14523f9](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/14523f9fbf642674a56f154c3c1f47b271972eb7))
## [0.36.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.36.0...0.36.1) (2023-06-22)
### Bug Fixes
* add plugin copy package ([ca85ae4](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/ca85ae49ecf2ef365646deee259e2cdc7c0bffcb))
## [0.36.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.35.0...0.36.0) (2023-06-22)
### Features
* advanced html export ([310777a](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/310777ab9fabaf6b3d275fcbe17d02129fb94475))
## [0.35.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.34.5...0.35.0) (2023-06-22)
### Features
* github action ([7a31ceb](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/7a31ceb58b60124fe0ca35d0fe2e129dba6b594d))
* html advanced ([62317d1](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/62317d1418090077f3e4c24e2088075ce30731fb))
## [0.34.5](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.34.4...0.34.5) (2023-06-22)
### Bug Fixes
* add comment ([06f435f](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/06f435f0ba7a5dbf4cc0a2d99edb4f27628c691c))
## [0.34.4](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.34.3...0.34.4) (2023-06-22)
### Bug Fixes
* add js files ([1d5ef78](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/1d5ef7825d296495d6c5a75b1daa1317b4ce0223))
## [0.34.3](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.34.2...0.34.3) (2023-06-22)
### Bug Fixes
* main ([7a0cf0d](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/7a0cf0da033166dc148da694d2f3f2c1e6a10dfc))
## [0.34.2](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.34.1...0.34.2) (2023-06-22)
### Bug Fixes
* main ([cbd1b89](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/cbd1b89158277333fdd654b58dc47c0698f715ec))
## [0.34.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.34.0...0.34.1) (2023-06-22)
### Bug Fixes
* main file ([c2f5d00](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/c2f5d00a20a7ebf4116f6dac36ff689fa97142d5))
## [0.34.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.33.1...0.34.0) (2023-06-22)
### Features
* advanced html ([a19ed79](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/a19ed790b4c02570cb8d3a23a9b804141eab8bc5))
## [0.33.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.33.0...0.33.1) (2023-05-25)
### Bug Fixes
* images import ([9504a37](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/9504a37213665dfddc8669abb40b56091464d452))
## [0.33.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.32.0...0.33.0) (2023-05-22)
### Features
* export on preview ([e8fd63e](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/e8fd63e6ee127208f5e1e01438bd3211bac73a2f))
## [0.32.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.31.0...0.32.0) (2023-05-11)
### Features
* Settings: Math Typesettings [#71](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/71) ([#74](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/74)) ([9e9c00f](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/9e9c00f9befc548f6159723a46e454aba905b475))
## [0.31.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.30.2...0.31.0) (2023-05-11)
### Features
* enable HTML setting ([#72](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/72)) ([97bd5b9](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/97bd5b9a1f744ea7a7fd50739ceefa142b356ae1))
## [0.30.2](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.30.1...0.30.2) (2023-04-28)
### Bug Fixes
* main.js location for deployment ([#65](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/65)) ([5a4ed39](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/5a4ed39b68887f1e0a674dd2771835e06aa570b3))
## [0.30.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.30.0...0.30.1) (2023-04-28)
### Bug Fixes
* local development ([4543176](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/4543176c9751ee71b1fa78a0e8955839e3ee12ba))
* local development ([3368d82](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/3368d82a3be159d52331544c1b3e8fd034913dab))
* Merge pull request [#63](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/63) from samuele-cozzi:fix/release-0.30 ([4543176](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/4543176c9751ee71b1fa78a0e8955839e3ee12ba))
## [0.30.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.29.1...0.30.0) (2023-04-28)
### Features
* autoscaling base ([#61](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/61)) ([d3e0fca](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/d3e0fca67f8944f2a6df93ae62410c9b381342ac))
## [0.29.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.29.0...0.29.1) (2023-03-15)
### Bug Fixes
* fixes for publish plugin ([#58](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/58)) ([01cd1f5](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/01cd1f5cbdb9c8ff23b5d773b8d2a9f2935685f4))
## [0.29.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.28.2...0.29.0) (2023-03-09)
### Features
* Features/docs base ([#56](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/56)) ([6a8076b](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/6a8076b888c16e5aaa57c96f297e34e84f12b46b))
## [0.28.2](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.28.1...0.28.2) (2023-03-08)
### Bug Fixes
* unit tests ([da08b9b](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/da08b9b122e6cfd1d5e14c6374521885ddb421cb))
## [0.28.1](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.28.0...0.28.1) (2023-03-08)
### Bug Fixes
* normalize path of pictures ([#53](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/53)) ([c362ae5](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/c362ae56a3d931bf154e4a2d043890f380a31760)), closes [#46](https://github.com/samuele-cozzi/obsidian-marp-slides/issues/46)
## [0.28.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.27.0...0.28.0) (2023-03-08)
### Features
* unit tests ([bc07f3c](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/bc07f3c0d3a4d58c55f2b0d2794f07826047b74e))
## [0.27.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.26.0...0.27.0) (2023-03-08)
### Features
* add unit tests ([f0cc955](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/f0cc955a9c08313cf6db663677a885342d56afa3))
## [0.26.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.25.0...0.26.0) (2023-03-04)
### Features
* move changelog ([ce87295](https://github.com/samuele-cozzi/obsidian-marp-slides/commit/ce87295fbbe2171a017238eaa4129ec31abc214f))
+69
View File
@@ -0,0 +1,69 @@
---
title: Developer Guide
nav_order: 6
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Developer Guide
## Develop & Test new Features
To get started, initiate the process by cloning this repository to your local environment. This will create a local copy of the entire project, allowing you to work on, modify, and contribute to the codebase seamlessly
```bash
$ git clone https://github.com/samuele-cozzi/obsidian-marp-slides.git
```
For testing purposes, make modifications to the esbuild.config.mjs file. This file contains configuration settings for esbuild, and adjusting its parameters will allow you to experiment with different build options and observe their effects on your project.
form:
```js
//outfile: "vault/.obsidian/plugins/marp-slides/main.js", //for local dev!!!
outfile: "main.js",
```
to:
```js
outfile: "vault/.obsidian/plugins/marp-slides/main.js", //for local dev!!!
//outfile: "main.js",
```
Proceed to compile and run the code. This step will apply your changes and generate the executable output, providing an opportunity to test and validate the impact of your configuration adjustments on the project's build and runtime behavior
```bash
# get packages
npm install
# biuld, test, run
npm run build
npm run test
npm run dev
```
Open the simple vault and test and validate the changes.
PLEASE REMEMBER: not commit the `esbuild.config.mjs` file!
## Create new Release
This repository use [Release please](https://github.com/googleapis/release-please) to automate CHANGELOG generation, the creation of GitHub releases, and version bumps.
"Release Please" is a GitHub Action that automates the release management process for software projects hosted on GitHub. Developed by Google, "Release Please" is designed to simplify the creation of GitHub releases by automatically generating release notes based on the changes made in the codebase since the last release.
The workflow involves using the tool to analyze the commit history, detect semantic version bumps (such as bug fixes, new features, or breaking changes), and compile release notes accordingly. It can then automatically create a new release on GitHub, including the generated release notes and a version tag.
### Create git commits or Merge commits
Release Please assumes you are using [Conventional Commit messages](https://www.conventionalcommits.org/).
The most important prefixes you should have in mind are:
* `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)
patch.
* `feat:` which represents a new feature, and correlates to a SemVer minor.
* `feat!:`, or `fix!:`, `refactor!:`, etc., which represent a breaking change
(indicated by the `!`) and will result in a SemVer major.
+24
View File
@@ -0,0 +1,24 @@
###########################################################
### Welcome to Beautiful Jekyll!
### This config file is meant for settings that affect your entire website. When you first
### set up your website you should go through all these settings and edit them, but after
### the initial set up you won't need to come back to this file often.
###########################################################
############################
# --- Required options --- #
############################
# Name of website
title: Obsidian Marp
# Your name to show in the footer
author: Samuele Cozzi
###############################################
# --- List of links in the navigation bar --- #
###############################################
remote_theme: just-the-docs/just-the-docs
plugins:
- jekyll-remote-theme
+26
View File
@@ -0,0 +1,26 @@
---
title: Home
nav_order: 1
created: 2025-09-09T19:23
updated: 2025-09-22T13:27
---
# Index
## Getting Started
- [Setup Vault](11.SetupVault.md)
- [Configuration](12.Configuration.md)
- [Marp Syntax](13.MarpSyntax.md)
- [First Deck](14.FirstDeck.md)
## Features
- [Slides Preview](21.SlidesPreview.md)
- [Slides Export](22.SlidesExport.md)
- [Slides Custom Theme](23.SlidesCustomTheme.md)
## Examples
- [Setup Vault](30.Examples.md#setup-vault)
- [Example Vault](30.Examples.md#example-vault)
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 492 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 485 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 504 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 308 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 867 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 224 KiB

File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 178 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 332 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 198 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB