oliverbalfour / obsidian-pandoc Goto Github PK

The accent (like é, é, à...) doesn't seem to work :

Thank you so much for making this plugin! I love pandoc, and was considering writing a plugin for Obsidian with this functionality until I found this one. Are there plans to have it added to the 'Community Plugins' in Obsidian?

Feature request: Ability to define the title either with YAML, or by having name of note be the title by default.

I'm not sure what the interface for this would be yet, but I'd like this personally for publishing my PKMS and several people on Discord have requested it. Example:

I wonder how feasible batch outputs would be 👀 , perhaps by specifying a (yaml) query
(@ foreveryone)

I'm thinking a "Pandoc Plugin: Batch export" option in the command palette, which comes up with a modal dialog. The modal would have some sort of very simple query system (eg fields for tags, search terms, YAML metadata, etc.) and options for a format to export to and a folder to export to.

This error happens when the embedded notes are not on the same folders as the main document.

Obsidian markdown document:

Exported .odt document:

Would it be possible to include content from other documents (possibly through something like https://hackage.haskell.org/package/pandoc-include) in one's conversion/export of a document? For example, if someone composed an essay out of other smaller notes, would be possible to export the entire essay from a single markdown file that pointed to those other notes under different sections?

If you export a file in a subfolder, the export is apparently saved to the root of the vault (I haven't seen this as my vault is one giant flat folder)

For some types like HTML which use relative paths to embed images, this behaviour is buggy. It should save next to the file exported like the documentation says.

I'll add a default export location setting though so you can specify a certain subfolder or choose to save exports next to the files they were exported from. This is instead of #8.

As stated in Pandoc User’s Guide, there exists a parameter (--self-contained) which creates a self-containing HTML file. Said file has no dependencies and is useful when it comes to portability without worrying about the images, videos, etc. being transformed as well.

Since the current HTML to HTML conversion doesn't use Pandoc -and by extension no Pandoc parameters-, I was wondering if there is a way to implement this parameter in order to create self-containing HTML files.

Cheers.

See #6

It looks like custom CSS isn't included, so I'll have to inject the CSS into Pandoc's output perhaps? This is problematic because syntax highlighting doesn't work.

Was this just because of weird formatting in the document I used?

Using a cross platform wrapper around xdg-open (this node module looks useful)

Another consideration: with the core Obsidian export to PDF feature, if you've saved as a PDF and still got the PDF open, it still opens a new PDF viewer. The simplest way to work around this is to add an option to disable the auto-open feature in the settings, so you can open it manually.

Have as few settings as possible without compromising on features. Collapse settings into one, have very good defaults, etc. Adding more config options just adds more work when using it. You should be able to never open the settings and have good results all the same.

Dataview plugin works great when exported via html not markdown
but when exporting a note1 having a (page1 with dataview plugin used) transcluded into it, it doesn't show output when exported into any format even when exported to html

Error message that Pandoc/LaTeX is not installed or accessible on my PATH despite being installed.

Thank you for your work, this is a great plugin.

Incorrect export files in word format, containing mathematical formulas (extra characters in front of formulas that are taken from the variable index):

However, if you export directly through pandoc, there is no problem:

Currently, if you have embedded images in your note, they must be in the same directory as the note to be exported.

I ask that an option to set the designated attachments folder is added, so as to not have to move the images to the note directory every time you want to export something.

Requested by @eleanorkonik on the Discord's #creative channel

Basically, you can write template files for most output formats which use a templating language to include bits of the input document. Using the Pandoc CLI the command will have a --template=file.tex if you've got a template called file.tex in the working directory or ~/.pandoc/templates.

My idea for the UX is to have a setting where you list files anywhere in your vault that you'd like to be templates (or specify a template directory?). Then, when you export, if there are any custom templates for that export type you should be prompted for the template you want, including the default one.

Related links:

• Official docs
• Default LaTeX template
• Simpler example

Hello! First of all this plugin is excellent. I would like to know if there is a possibility to export your notes to html but keeping the CSS style of your Obsidian theme. It would be really helpful because I want to use github and netlify to manage a personal blog so I could export my notes directly with the css settings already included.

Best regards.

Feature request from Robert Haisfield

Great Plugin

Great plugin, was wating for this since ages

Current Issue

• When currently export .md to any format, internal links [[Link]] doesn't work

Dokuwiki

• Exporting whole folder as .txt files with dokuwiki formatting, one can upload it to dokuwiki server, hence internal links would be preserved

Benefits

• One can directly publish his/her work on dokuwiki server

Hi,

I have pandoc version 2.7 on my computer and also TexLive (with pdflatex.exe programme inside).
When I try to export a md note to a pdf note with your plugin (it works in command lines with pandoc), I receive this message :

"pandoc export failed: pdf-engine xelatex is not compatible with output format pdf"

Please could you tell me how I could solve this problem?

Regards,

The ![[note name]] syntax for embedding files currently doesn't work.

This is a little tricky as it involves loading note name.md and then applying my markdown rendering + post-processing stages. This code is currently coupled with the Pandoc subprocess spawning code so a minor refactor is required.

This feature will also have to be careful about recursion - if a note is embedded within itself any number of layers deep (you could have normal recursion, mutual recursion, etc.), you will get an infinite loop.

Note to self: see this bug report for a suggestion on how to handle recursive note embeds.

If you have something like this at the top of your note:

---
title: Test
---

It will appear in the exported output, which is (generally) undesirable.

OS: ElementaryOS Hera (based on Ubuntu 18.04.4 LTS)

Issue: I cannot get working the plugin in Linux although I use pandoc CLI very often without any problem. The output of which pandoc command inside the terminal is right: /usr/bin/pandoc. I've install pandoc from a .deb package and I'm wondering if it's because some path divergence from the installation method; but I'm lost. I attached the Obsidian console output of the errors for every path I have find a pandoc file.

Any idea of what is going wrong?

Relates to #21 - this is a quick intermediate fix to support citations, at the cost of being slightly less user friendly (docs can help though).

The idea is there should be a setting where you can add stuff like this to the command (from SkepticMystic):

--citeproc --csl "https://raw.githubusercontent.com/citation-style-language/styles/master/apa.csl" 
--bibliography "Zotero Exports\My Library.json" 
--reference-doc="Pandoc\Templates\APA7.docx" 

My literature notes all contain footnotes and therefore I always encounter the following error message when exporting:

I might make showing a dialog a toggle-able setting, as I quite like being able to just choose an option without worrying about where the file should go.

Feature request: Support inclusion of mermaid diagrams in export

"Plugin ID mismatch" error when trying to click on Obsidian-Pandoc plugin through Community Plugins.

Embedding entire notes via ![[note]] works fine, but adding block references to the mix like ![[note^uid]] or even ![[^uid]] (which embeds a block inside the current note) will not work.

The concerning part is it will fail silently - no error notification. It eventually generates an export file but it takes absurdly long (presumably waiting for a timeout of some kind). The export just displays note > uid instead of the embedded note as desired.

Note to self: be careful not to regress the recursion limiting behaviour introduced in #5.

Is there an Obsidian API function to turn a ![[note^uid]] embed string into a source markdown string or similar? That would be a far more scalable way of doing this. (edit: yes, there's a method in the metadata cache API)

Hi! I would like to ask if there is any chance to make a dataview plugin integration with the pandoc plugin.

Today I tryed to export a note to html but the plugin show me this in the console.

So, in this sense it would be very useful if you could render the kind of notes that have dataview tables and lists with pandoc.

Thanks in advance.

** removing markdown links**

your plugin is released with an awsome feature, the possibility in the settings to choose the way links will be processed.
When I use pandoc, the output contains links to other notes between brackets. I do not want these links to be active, but I would like the brackets to be removed as well. Do you know how this task is done in your plugin (which part of the command line is responsible for that?)

Regards,

Damien

We once had a discussion about the possibility of preserving/adding CSS settings for export to PDF.
Since it is not listed in your features, I wonder if this is still pending? Is it even on your roadmap?

Current issue

• When currently exporting any file into other format [.docx, .html], internal links doesn't works

Request

• Docx: When exporting a index page, that page would become "Table of content" of the embeeded content in same document
• Html: Export index page with all [[internally linked pages]], so that [[internal link]] would be preserved

Is it possible be able to export a document from a nested markdown outline of inclusions ![[page(n)]] so that it removes the indentations before exporting? That way I can order different pages as sections of a single manuscript for compilation?

• [[page_1]]
  • [[page_4]]
• [[page_5]]
  • [[page_2]]
    • [[page_3]]
      • [[page_8]]
  • [[page_7]]
• [[page_6]]

And/Or

Be able to include in an export an inclusion on a page that I am including. For example in a page I exporting [[page_1]], include "![[page_2]]" where that page include another "![[page_3]]

The first option would allow for compilation of document organized with the outliner plugin, creating functionality like Scrivener!

Thank you in advance!

Suggested by Mara & SkepticMystic on Discord #plugins

See https://pandoc.org/MANUAL.html#citations

We'll need to
a) add a setting to specify a database file
b) parse [@foo, p. 33] syntax into whatever Pandoc likes best
c) add a --citeproc option to the CLI commands
d) ...

This will be enormously helpful in conjunction with Zotero and the Obsidian citation plugin

This may be a fair bit of work. I'll tentatively mark it for the 0.2.0 release and push it back a week or two if needed (possibly after submission to the community plugins list).

Hi,

I have tried to load your last release in my vault but the message I have received was:

"failed to load plugin obsidian-pandoc-plugin"

The plugin cannot be activated in Obsidian.

Regards.

The "official" source of documentation at my company is in Mediawiki, but I much prefer to write in Markdown in Obsidian. Sometimes, I need to transform my notes into real documentation, so it'd be great if I could do it via this plugin.

Pandoc supports mediawiki as an output format.

Thanks!

Great plugin. I tend to break my writing projects into separate sections/chapters - sometimes a large number of them. I control their order by name e.g. 000 Introduction, 002 Chapter 1, 003 Chapter 1 Notes, 004 Chapter 2

What would be useful is if the export could be done on a folder. It would then run through the files in alphabetical order and export to the requested format as a single document. I know applications like Zettlr can do this for nested folders ("projects") but a single folder and its md content would be sufficient for me. The pandoc command itself is pretty straightforward - just passing multiple filenames as the input instead of just one.

I'd like to help but need to get my head around how plugins work first!

I tried to export a file (I tried two different files, actually) and got the following error:

I tried exporting as .docx using pandoc and the export as html without pandoc option.

Feature request: Removing [[]] links before export to none hypertext (e.g. odt, docx, etc)

For the HTML output, it might be nice to have PDF embeds work (note: be careful with the ![[doc.pdf#page=number]] syntax). Audio/video is relatively easy, not sure about PDF though.

For export types other than HTML, multimedia embeds should just be stripped entirely. There's no value in leaving behind filenames or other artefacts, it should just be purged.

• Add example files for each export format to an examples subfolder
• Add instructions for how to write for each export type
  • Slideshow formats use --- (ie <hr>) to demarcate slides
  • You can use ---\ntitle: my title\n--- YAML frontmatter
• Explain what sort of new workflows this plugin enables
  • Writing books - just use ![[Chapter1]] ![[Chapter2]] ... and export as PDF/ePub/Word/etc
  • Fancy presentations - explain Reveal.js
  • Drafting LaTeX documents and eBooks
  • Making static websites (like Obsidian publish, but you can put them on a USB drive or use GitHub Pages/Jekyll)
  • Writing assignments in Obsidian and exporting them to whatever format you need them in
  • Explain obscure export types and why they're worth using
  • Writing Word documents without Word
  • Ultimately, it lets you do more inside Obsidian (centralised PKMS) and in a simpler interface, and still interface with the outside world
• Update the list of caveats and the screenshot
• Mention you can put tags in YAML frontmatter to hide them in the output
• Mention #15 and the fix for it if it's just a PATH configuration issue

Suggested by @ argentum on Discord # general

This would let you customise the LaTeX preamble, packages, fonts, etc. without having to export to TeX, manually edit, and manually invoke pdflatex. Super cool idea for reducing friction in the export workflow, and the Zettlr devs have done the hard work designing the UX already.

Docs: https://docs.zettlr.com/en/academic/custom-templates/

This is definitely a post 0.2.0 thing, and it will come after the bibliography work too

Hi @OliverBalfour,

I'm a noob user. I reached the settings panel with the pandoc path to the folder which has pandoc application. But it seems that Pandoc is not enabled yet as it says Pandoc is not installed or accessible on your PATH. This plugin's functionality will be limited.

Checked again in the terminal:

Thanks Oliver.

** yaml metadata **

I have noticed that the only metadata from the YAML frontmatter which appears to be processed by the pandoc-obsidian plugin is the title (--metadata title=). Why other elements (subtitle, author, date) do not appear in the PDF ?

Could you tell me please if there is a way to fix it?

Regards,

Damien

I like to write with Obdisian's outliner plugin, but would like to export the file without the outline markup. Is it possible to automate the removal of outline indentation before export? Thanks!

This should (hopefully!) be a one line fix to pandoc.ts. There may be some formatting issues though.