Markdown plugin for RapidWeaver (MarkdownPlugin-0.9)
I have created a plugin for RapidWeaver that adds support for the well known Markdown structured text format.
Since Markdown uses a plain text format with embedded markup, Markdown files are highly readable text files, but can be also transformed into HTML markup. For detailed documentation of the Markdown syntax, please refer to the Markdown Website.
Optionally, the plugin also allows you to use SmartyPants to apply typographical goodies to your text, for instance replacement of quotes and dashes. For detailed information on SmartyPants, please refer to the SmartyPants Website.
MarkdownPlugin is released as open-source under the MIT license. I will publish the source code on this website soon.
Installation
The installation of the plugin is simple:
- download MarkdownPlugin
- unzip the plugin and copy the plugin to ~/Library/Application Support/RapidWeaver
After restarting RapidWeaver, you will be able to add a new Markdown page type to your RapidWeaver project.
Warning
This is my first RapidWeaver plugin, and the code may still contain bugs. You are using MarkdownPlugin at your own risk, backup your work before using MarkdownPlugin.
Update Replaced plugin with version that contains a slightly updated documentation, but is unchanged besides that.
Great job on the markdown plugin. I works great for me and saves me from translating markdown in Textmate.
I would really be interested in how you made the plugin as I am about to start work on one too. Any chance you’ll be distributing the source code?
Thanks again,
Robert
Hi Robert
I’m glad to hear that you find the plugin useful. Of course, I will release the source code to the plugin, I’m just very busy these days, but I plan to release the source today or tomorrow.
Best regards,
Christian
Hello, my name is Alex, i’m a newbie here. I really do like your resource and really interested in things you discuss here, also would like to enter your community, hope it is possible:-) Cya around, best regards, Alex!
Howsabout releasing that source-code soon?
I’m thinking of trying to do something similar, except I’d like to use LaTeX to make png-formatted mathematical equations (and musical notation, and perhaps other things) in the output pages. I’d love to work off your code as a template, since I haven’t really done any serious cocoa/objc programming before.
BTW: I use your markdown plugin extensively. I believe I may have been one of the first persons to use it, since you emailed it to me personally before it was released. Thanks a ton!
update… my mistake. It was AndrĂ© Pang’s plugin I’d been using. Haven’t tried yours yet since I haven’t had a need — I’m sure it’s as good.
Nevertheless, seeing the code released would be great.
and yet again I am mistaken…. I just found the link to the source and downloaded. Sorry. I’ll stop bombing you now. Thanks for the code! Looking through it now.
cool plugin, really useful. But: How to include images? I’ve read the syntax docu, but where do I put my original images, so that I can link to them from a markdown RW-page? Maybe someone’s got an example
regards,
Gernot
Hi Gernot. Thanks for the feedback. I have addressed your question in a this new article in my blog.
Christian,
I created my (new) rbs website completely from markdown, but I experience regular problems (which cannot be traced by the RW-guys…): When I paste large portions of markdown (which I write in Textmate) into the RW-plugin-pages, RW crashes… ever heard of that before?
It does not happen every time though … strange. Otherwise I’m still VERY happy… RW would be completely useless for me without markdown-support!
thx,
Gernot
Hi Gernot,
I have an unreleased version of the plugin that includes a fix contributed by another Markdown plugin user. This version solves a problem that can result in a a crash of RapidWeaver.
I think I will have some time in the next weeks to release this small update. Maybe this version solves your problem.
Cheers,
Christian
Christian,
please consider releasing an update – I’m really stuck with loads of markdown and loads of RapidWeaver crashes… (and no time to get used to your sources…)
and I don’t (yet) wanna give up RapidWeaver – although I consider it…
thanx,Gernot