Home → Suggestions →

MultiMarkdown support for knowledge base

• Edit

ioa

25 Jan, 2012 06:41 AM

Something I would find useful in crafting articles is access to some of MultiMarkdown's additional features. Namely, tables and footnotes. A big advantage to choosing MMD is that it is backward compatible with Markdown, so no existing articles would be damaged by the transition. It is a superset to MD. You might even see a speed boost and CPU usage drop, depending on which MD processor you currently use, as MMD3 is written in C, and is swift enough to provide realtime results when coded into a text editor with a preview window.

1. 1 Posted by Nicole on 25 Jan, 2012 05:55 PM

   

   Ioa -

   Our version of Markdown should render tables done like the following

   |Left align|Right align|Center align|
   |:---------|----------:|:----------:|
   |This|This|This|
   |column|column|column|
   |will|will|will|
   |be|be|be|
   |left|right|center|
   |aligned|aligned|aligned|
   

   as

   	Left align	Right align	Center align
   	This	This	This|
   	column	column	column|
   	will	will	will|
   	be	be	be|
   	left	right	center|
   	aligned	aligned	aligned|

   And MMD uses the Markdown implementation for footnotes. From the MMD user manual -

   I have added support for footnotes to MultiMarkdown, using the syntax proposed by John Gruber. Note that there is no official support for footnotes yet, so the output format may change, but the input format sounds fairly stable.

   Let me know if you have any other questions.

   Thanks,
   Nicole

   • Edit

2. Nicole closed this discussion on 25 Jan, 2012 05:55 PM.

3. ioa re-opened this discussion on 25 Jan, 2012 10:07 PM

4. 2 Posted by ioa on 25 Jan, 2012 10:07 PM

   

   Nicole,

   Okay, I think what threw me off is that the Preview parser seems to be different than the production parser. Now that I post a draft and look at it in the final CSS, the tables work nicely. They kind of only partially work in the pop-up preview.

   Footnotes however don't seem to be functional for me.[^test]

   [^test]: isn't creating a footnote, but is instead creating a hyperlink to the first word in the footnote. So for instance, in this case, the it would create a hyperlink to `http://help.tenderapp.com/kb/something/isnt`.

   That is, at any rate, the MMD usage. I'm not aware of any Markdown native syntax, though I know the MMD XHTML implementation of footnotes is indeed based off of Gruber's design, all the way down to the same Unicode character for the link-back. The only place I have ever found that Gruber quote is on Fletcher Penney's websites and readmes. :)

   • Edit

5. 3 Posted by Nicole on 26 Jan, 2012 07:10 PM

   

   Ioa -

   Try something more like the following for footnotes.

   I get 10 times more traffic from [Google] [1] than from
   [Yahoo] [2] or [MSN] [3].
   
     [1]: http://google.com/        "Google"
     [2]: http://search.yahoo.com/  "Yahoo Search"
     [3]: http://search.msn.com/    "MSN Search"
   

   Thanks!
   Nicole

   • Edit

6. Nicole closed this discussion on 26 Jan, 2012 07:10 PM.

7. ioa re-opened this discussion on 26 Feb, 2012 09:39 PM

8. 4 Posted by ioa on 26 Feb, 2012 09:39 PM

   

   Sorry for the delayed response. This doesn't work for me, you seem to be demonstrating the referenced link method, as opposed to the inline link method. `[Google](http://www.google.com)` vs. `[Google][]`.

   [Google]: http://www.google.com/

   What I meant to ask for are actual *footnotes* in the rendered copy, where this`[^footnote_id]` would appear at the bottom of the document. It's for auxiliary information that is not important to the paragraph or sentence itself, but might help the user out, or to cite a reference to some external quote. So I mean this more in the publishing sense than the code sense.

   [^footnote_id]: This text of the footnote, as it would appear at the bottom of the page.

   --
   Ioa Petra'ka

   • Edit

9. 5 Posted by Amanda on 27 Feb, 2012 10:52 PM

   

   Ioa,

   I'll make a ticket for our devs to consider adding MultiMarkdown support. Thank you for the feedback!

   • Edit

10. Nicole closed this discussion on 29 Jun, 2012 06:14 PM.

11. Julien closed this discussion on 17 Jul, 2012 09:31 PM.