obsidian-plugin/samuele-cozzi_obsidian-marp-slides
1
0
Fork 0
mirror of https://github.com/samuele-cozzi/obsidian-marp-slides.git synced 2026-07-22 07:40:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add license

Browse source
This commit is contained in:
samuele-cozzi 2023-02-24 18:37:33 +00:00
parent 705a236e81
commit 52fa0704d5
3 changed files with 53 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 samuele-cozzi
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.

29
README.md
View file

@ -1,14 +1,21 @@
# Marp Slides for Obsidian
[![Version](https://img.shields.io/github/manifest-json/v/samuele-cozzi/obsidian-marp-slides?color=blue)](https://github.com/samuele-cozzi/obsidian-marp-slides/releases/latest)
![Downloads](https://img.shields.io/github/downloads/samuele-cozzi/obsidian-marp-slides/total)
[![CodeFactor](https://www.codefactor.io/repository/github/samuele-cozzi/obsidian-marp-slides/badge)](https://www.codefactor.io/repository/github/samuele-cozzi/obsidian-marp-slides)
[![Maintainability](https://api.codeclimate.com/v1/badges/78932986b29ffe273e56/maintainability)](https://codeclimate.com/github/samuele-cozzi/obsidian-marp-slides/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/78932986b29ffe273e56/test_coverage)](https://codeclimate.com/github/samuele-cozzi/obsidian-marp-slides/test_coverage)
[![LICENSE](https://img.shields.io/github/license/samuele-cozzi/obsidian-marp-slides)](https://github.com/samuele-cozzi/obsidian-marp-slides/blob/main/LICENSE)
---
Marp Slides is simple slide deck extension for [Obsidian](href="https://obsidian.md")
Advanced Slides is the perfect slide deck extension for <a href="https://obsidian.md">Obsidian</a>
![](https://raw.githubusercontent.com/marp-team/marp-vscode/main/docs/screenshot.png)
![](https://raw.githubusercontent.com/MSzturc/obsidian-advanced-slides/main/imgs/demo.gif)
See the documentation of [Marpit Markdown](https://marpit.marp.app/markdown) and [the features of Marp Core](https://github.com/marp-team/marp-core#features) about how to write.
> Please refer **[https://marp.app/][marp]** for more details of Marp ecosystem. We have powerful tools for Marp Markdown: [Marpit Framework](https://marpit.marp.app/), [CLI tool](https://github.com/marp-team/marp-cli), [Web interface](https://web.marp.app/) and so on.
[marp]: https://marp.app/
---
@ -24,6 +31,22 @@ image
### Export deck (html, pdf, pptx, img)
We have integrated [Marp CLI][marp-cli] to export your deck into several formats.
To export the content of active Markdown editor execute command from the Command Palette (<kbd>F1</kbd> or <kbd>Ctrl/Cmd+P</kbd>).
[marp-cli]: https://github.com/marp-team/marp-cli/
#### Supported file types
- **HTML**
- **PDF**
- **PPTX** (PowerPoint document)
- **PNG** (_First slide only)_
- **JPEG** (_First slide only)_
> ⚠️ 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 `markdown.marp.chromePath`.
image
### Custom Theme

13
src/utilities/marpExport.ts
View file

@ -1,4 +1,4 @@
import { CLIError, CLIErrorCode } from '@marp-team/marp-cli'
import marpCli, { CLIError, CLIErrorCode } from '@marp-team/marp-cli'
export class MarpCLIError extends Error {}
@ -32,7 +32,7 @@ export class MarpExport {
throw e
} finally {
process.env.CHROME_PATH = CHROME_PATH
//process.env.CHROME_PATH = CHROME_PATH
}
}
@ -66,10 +66,11 @@ export class MarpExport {
//console.info(`Execute Marp CLI [${argv.join(' ')}] (${JSON.stringify(opts)})`)
console.info(`Execute Marp CLI [${argv.join(' ')}]`);
console.log(process.env.CHROME_PATH);
const { marpCli } = await import(
'@marp-team/marp-cli'
)
// const { marpCli } = await import(
// '@marp-team/marp-cli'
// )
//exitCode = await marpCli(argv, opts)
marpCli(argv)
@ -84,7 +85,5 @@ export class MarpExport {
console.log("Errore");
console.log(e);
});
}
}