Using markd with github wiki

Keith Bierman's Avatar

Keith Bierman

05 May, 2017 11:02 PM

To work offline, I've cloned a repo's wiki. Markd does a great job rendering any given file.... however, the wiki has become fairly complex, I was hoping to have a simple way to review all of the material offline ... so something like pointing markd at the top of the wiki ( seemed like a good bet.,..but instead of live links, I see the markup ... like

 *. [[System Overview]]
 * [[Team Charter]... etc.

and the [[text]] aren't treated as live links.

What should I do differently to get local rendering to match what I see poking around the online version?

Thanks in advance,

  1. Support Staff 1 Posted by Brett on 05 May, 2017 11:15 PM

    Brett's Avatar

    The double bracket wiki syntax isn't markdown, so you'd have to write a script to run as a custom preprocessor that converted them appropriately.

    You can drop the parent folder onto marked to display the file being edited, but it will only show one at a time and only the most recently modified.

    Note that Marked isn't a full browser and won't provide back/forward navigation when viewing linked files. One option is to generate an index that Marked can recognize (such as GitBook or LeanPub format) and view the whole wiki as a single document.

    - Brett

  2. 2 Posted by Keith Bierman on 05 May, 2017 11:23 PM

    Keith Bierman's Avatar

    Yes, it's not mark down as such ... it's a wiki (github projects have the
    code, and a standard wiki). Please consider it an RFE to handle enough of
    the github wiki language (they provide a FOSS library for processing the
    text) ... it would be a very nice touch I think.

    Keith Bierman
    [email blocked]
    303 997 2749

  3. Support Staff 3 Posted by Brett on 05 May, 2017 11:29 PM

    Brett's Avatar

    It's not a common enough use case to force on everyone, and the handling of wiki links varies between systems. Writing a preprocessor for marked, though, is as simple as writing a command line script, and you can handle syntax any way you need to.

    - Brett

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:


Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac