iandol / scrivomatic

A writing workflow using Scrivener's style system + Pandoc for output…
https://iandol.github.io/scrivomatic/
GNU General Public License v3.0
297 stars 30 forks source link

Question -- styles vs convert markdown #21

Open mk-uc opened 5 years ago

mk-uc commented 5 years ago

Question: I noticed that Scrivener has an option to 'Convert Rich Text to Markdown' which basically attempts to do just that. Is there a benefit of using Styles, as you've indicated, over this option? Are there clear downsides to using this convert option? It seems both would export to the same markdown format.

I'm thinking about this because I plan to also use scrivener extensively on iOS, and while it seems that styles might sync across, it's not possible to bind keyboard shortcuts to styles, and might make writing on iOS more difficult.

Apologies if this is too far off the current repository.

iandol commented 5 years ago

The traditional problem was that Convert Rich Text to Markdown would also escape all other markdown, and break combining rich text and markdown syntax (there are several threads on the forums about this). BUT in a recent update you can disable escaping, which improves the ability to mix-and-match these two. I still prefer the semantic "purity" of using styles, but understand how clumsy it is to use on iOS at present, so you should be able to try it: but note you must then be careful not to use characters like [ ] and unless you want them to be markdown...

mk-uc commented 5 years ago

I don’t use too much markdown aside from bold and italics, (in the humanities not the sciences). HOWEVER, I do use Pandoc, which uses [] for citations. Would that be a problem if trying to use Convert Rich Text to Markdown?

iandol commented 5 years ago

Yes, by default Convert Rich Text to Markdown will escape Pandoc citations like so: \[@shipp2013\] — and therefore Pandoc cannot read them. BUT as I said before if you are using at least Scrivener V3.1.1 then the option Escape special characters was added, make sure it is OFF: Screenshot 2019-04-03 at 07 58 05

Try to compile and see works for you...