https://github.com/Gewerd-Strauss/ObsidianKnittr

Autohotkey Script for automating the use of ObsidianHTML and Quarto/RMarkdown to generate pandoc-rendered files from Obsidian.MD's markdown-flavour
https://github.com/Gewerd-Strauss/ObsidianKnittr

Last synced: 3 months ago
JSON representation

Autohotkey Script for automating the use of ObsidianHTML and Quarto/RMarkdown to generate pandoc-rendered files from Obsidian.MD's markdown-flavour

• Host: GitHub
• URL: https://github.com/Gewerd-Strauss/ObsidianKnittr
• Owner: Gewerd-Strauss
• Created: 2023-01-02T23:45:12.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T19:09:17.000Z (3 months ago)
• Last Synced: 2024-11-04T20:21:18.230Z (3 months ago)
• Language: AutoHotkey
• Homepage:
• Size: 1.03 MB
• Stars: 15
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - Gewerd-Strauss/ObsidianKnittr - Autohotkey Script for automating the use of ObsidianHTML and Quarto/RMarkdown to generate pandoc-rendered files from Obsidian.MD's markdown-flavour (AutoHotkey)

README

        
Note: I am currently working on a major refactoring and expansion rewrite, but this will take time for various private reasons. Once that rewrite is completed, an attempt at a proper documentation is going to be (finally) written, as I expect the project to reach proper feature-completeness at that point. 

# ObsidianScripts

 A variety of Obsidian.md helpers, in varying states of completion.

## ObsidianKnittr:

Wrapper-Script around [ObsidianHTML](https://github.com/obsidian-html/obsidian-html)  for exporting obsidianMD-notes to a variety of formats.

### Running the script:

Run the script, set your intended output formats and select an ObsidianMD-note to be converted. Note that due to the way ObsidianHTML works, this script will not work in folders which are not part of an obsidian vault.

Note that some of those require additional setup in R first. For more information, attempt to knit via R as you would normally do (f.e via RStudio) and refer to the documentation.

### Supported Formats:

1. "html_document" 

2. "pdf_document" * Note: `RMarkdown::Render()` cannot compute `.svg`-files as images if using the `pdflatex`-engine. Other engines not tested yet.

3. "word_document" 

4. "odt_document"

5. "rtf_document" 

6. "md_document"

7. "powerpoint_presentation"

8. "ioslides_presentation" 

9. "tufte::tufte_html" 

10. "github_document"

Note that those are not all formats that _could_ be supported, RMarkdown supports [those](https://rmarkdown.rstudio.com/lesson-9.html). However, not all of them are viable imo. If you want to extend them, edit the variable `PotentialOutputs` in the function `guiCreate()`.

### Dependencies:

ObsidianKnitter requires the installation of

- ObsidianHTML

- R (tested on 4.2.2, other versions might break)

- [this](https://gist.github.com/Gewerd-Strauss/8ee61682aef45c0d124b19afaeedc2fe) gist for the script.ahk include for commits older than 25.07.2023 22:10.