enhance documentation

This commit is contained in:
samuele-cozzi 2023-09-10 12:41:43 +02:00
parent 27017d322f
commit 3e114f3fa1
9 changed files with 47 additions and 1 deletions

View file

@ -1,3 +1,8 @@
---
title: Getting Started
nav_order: 2
---
# Getting Started
## Setup Vault

11
docs/20.Features.md Normal file
View file

@ -0,0 +1,11 @@
---
title: Features
nav_order: 3
has_children: true
---
# Features
- [Slides Preview](21.SlidesPreview.md)
- [Slides Export](22.SlidesExport.md)
- [Slides Custom Theme](23.SlidesCustomTheme.md)

View file

@ -1,3 +1,8 @@
---
title: Slides Preview
parent: Features
---
# 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.

View file

@ -1,3 +1,8 @@
---
title: Slides Preview
parent: Features
---
# 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.

View file

@ -1,3 +1,8 @@
---
title: Slides Preview
parent: Features
---
# 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.

View file

@ -1,3 +1,8 @@
---
title: Examples
nav_order: 4
---
# Examples
## Setup Vault

View file

@ -1,3 +1,8 @@
---
title: Changelog
nav_order: 99
---
# Changelog
## [0.38.0](https://github.com/samuele-cozzi/obsidian-marp-slides/compare/0.37.1...0.38.0) (2023-09-10)

View file

@ -10,7 +10,7 @@
############################
# Name of website
title: Obsidian Marp Slides
title: Obsidian Marp
# Your name to show in the footer
author: Samuele Cozzi

View file

@ -1,3 +1,8 @@
---
title: Home
nav_order: 1
---
# Index
## Getting Started