Comments

Subscribe to the comments RSS feed.

Comment #1 posted on 2018-03-27 08:10:58 by clacke

Markdown shownotes

klaatu and Ken were discussing the merits on Markdown and the horribleness of the multitude of markdown flavors.

Here's what I do for shownotes: I write on hashify.me.

Markdown on the left, live rendered text on the right so you can easily Ctrl-click links to check them etc. Then I mark the text on the right, right-click and choose "View selection source" (this is on Firefox). It opens a new tab with the source almost correctly marked. I mark it, copy and then paste into the show notes textbox and choose HTML5 as text type.

Comment #2 posted on 2018-04-04 01:35:03 by clacke

ASCIIDoc shownotes

If you like ASCIIDoc, you can type your shownotes on https://asciidoclive.com/ and then do the same thing as I described above with hashify.me.

Just like hashify, asciidoclive allows you to type on the left, see the result on the right.

Comment #3 posted on 2018-04-04 12:00:53 by Dave Morriss

Markdown/ASCIIDoc

Hi clacke,

A couple of interesting finds. I use both Markdown (Pandoc flavour mostly) and ASCIIDoc (via Asciidoctor).

I write all my HPR shownotes with Markdown, using Vim on one monitor and a browser on the other, building the output with Pandoc via Make, using Vim's 'make' interface to do it.

I also like to write a journal per project and use ASCIIDoc for that because I can generate much more interesting documents with colour, side notes, icons, good tables and so on. Again Vim lets me type the document with syntax highlighting, build it with 'make' and display it on my right-hand monitor using a dedicated browser (I like QupZilla at the moment).

My solution is probably massively over-engineered but I like it :-)

Comment #4 posted on 2018-04-04 13:38:29 by clacke

Overengineering

Doesn't sound terribly overengineered to me, it's just that my web editing workflow is minimalistic almost to a fault.

I have an engineered piece you can add to your solution: Trigger the builds automatically with entr[0]. That allows you to even skip the make step in vim. Just save and things happen.

Actually what I often do is I just `watch make` in the directory where I'm editing, or `while sleep 5; do make; done`.

Comment #5 posted on 2018-04-05 11:59:46 by Dave Morriss

Re: Overengineering

Thanks clacke,

I have used 'entr' in the past, actually to refresh my note-viewing browser when the notes change. I now use Qupzilla because it does that all by itself, which is very cool!

I will think about using 'entr' or 'watch' in future, but for HPR shownotes I have several 'make' targets, so I'm not sure if I want to automate them all.

For example I use 'make final' to generate notes with HPR links rather than the local ones I use while developing them, and I can only do that once I have chosen a slot and know what the HPR links will be. Of course, I could trigger the 'make final' once the slot has been selected.

Anyway, thanks for the idea :-)

Comment #6 posted on 2018-04-05 14:25:25 by clacke

Re: Overengineering

It seems that when I countered that your setup didn't seem massively overengineered, I was simply insufficiently informed.

Now that this has been somewhat remedied, I agree with your assessment.

Leave Comment

Note to Verbose Commenters
If you can't fit everything you want to say in the comment below then you really should record a response show instead.

Note to Spammers
All comments are moderated. All links are checked by humans. We strip out all html. Feel free to record a show about yourself, or your industry, or any other topic we may find interesting. We also check shows for spam :).