Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AndreasThinks/obsidian-to-quarto-exporter
Export Obsidian notes to Quarto-compatible QMD files.
https://github.com/AndreasThinks/obsidian-to-quarto-exporter
obsidian obsidian-plugin quarto
Last synced: 2 months ago
JSON representation
Export Obsidian notes to Quarto-compatible QMD files.
- Host: GitHub
- URL: https://github.com/AndreasThinks/obsidian-to-quarto-exporter
- Owner: AndreasThinks
- License: mit
- Created: 2024-08-22T11:49:34.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T13:49:57.000Z (3 months ago)
- Last Synced: 2024-10-21T21:57:43.917Z (3 months ago)
- Topics: obsidian, obsidian-plugin, quarto
- Language: TypeScript
- Homepage:
- Size: 48.8 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Obsidian to Quarto Exporter
This plugin for Obsidian (https://obsidian.md) allows you to export your Obsidian notes to Quarto-compatible QMD files. It provides various options to customize the export process, including date formatting, tag handling, and output file management.
## Features
- Export Obsidian notes to Quarto-compatible QMD format
- Add creation or modification date to exported files
- Customize date format
- Option to include or exclude tags from Obsidian notes
- Specify output folder for exported files
- Choose to overwrite existing files or create new ones
- Converts Obsidian-specific syntax to Quarto-compatible format
## Installation
### From the Obsidian Community Plugins
1. Open Obsidian Settings > Community Plugins
2. Disable Safe Mode
3. Click Browse community plugins
4. Search for "Quarto Exporter"
5. Click Install
6. Once installed, close the community plugins window and activate the newly installed plugin
### Manual Installation
1. Download `main.js`, `manifest.json`, and `styles.css` (if available) from the latest release in the GitHub repository.
2. Create a new folder named `quarto-exporter` in your vault's plugins folder: `/.obsidian/plugins/`
3. Move the downloaded files into the `obsidian-to-quarto-exporter` folder.
4. Reload Obsidian
5. If prompted about Safe Mode, you can disable safe mode and enable the plugin.
Otherwise, head to Settings, third-party plugins, make sure safe mode is off and
enable the plugin from there.
## Usage
1. Open the Obsidian note you want to export.
2. Use the command palette (Ctrl/Cmd + P) and search for "Export to Quarto QMD".
3. The plugin will create a new QMD file based on your settings.
## Settings
- **Date Option**: Choose to add creation date, modification date, or no date to the exported file.
- **Date Format**: Specify the format for the date (e.g., YYYY-MM-DD).
- **Output Folder**: Set a specific folder for exported files, or leave blank to use the same folder as the original note.
- **Overwrite Existing Files**: Choose whether to overwrite existing files or create new ones with incremented names.
- **Import Tags**: Decide whether to include tags from the Obsidian note in the exported Quarto file.
## Development
If you want to contribute to the development of this plugin, follow these steps:
1. Clone this repository.
2. Run `npm i` to install dependencies.
3. Run `npm run dev` to start compilation in watch mode.
## Manually installing the plugin
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/quarto-exporter/`.
## Support
If you encounter any issues or have feature requests, please file them in the Issues section of the GitHub repository.
## License
[MIT](LICENSE)