Skip to content

Publish Markdown Plugin

Trevor Williams edited this page Apr 25, 2020 · 4 revisions

In our last tip, we went over how to manually order files and directories within the TKE sidebar. What we didn't cover is why you would ever want to manually sort files in the sidebar in the first place. One such reason we would do this is to control the order that files are processed within a directory from something like a plugin. The Publish Markdown plugin is one plugin which uses the sidebar ordering of the files to collate Markdown files into a single file and then hand that single file to a Markdown processor for export. This allows you to split your Markdown document into separate files (say, a file per chapter or section) and then organize the files into a particular order to generate a single export document.

After the plugin is installed, it is accessible by right-clicking on a sidebar item. If the item is a directory, all files within the directory and all of its subdirectories will be traversed and organized, in order, into a single temporary Markdown file. After this is complete, the export window will be displayed.


If you want to save the file, select "Publish To", select a directory to save the file to, and click "Publish".

If you want to export the file as HTML directly, select "Publish To", select a directory to save the HTML file to, select the "Export As HTML" option, and click "Publish".

If you want to send the resulting file to an external application, select "Open In", choose the application from the dropdown list (more on this in a bit), and click "Publish".

Plugin Options

The Publish Markdown plugin has several options to configure its behavior that are accessible from the Preferences window within the Plugin panel. Select the "publish_markdown" option from the pull-down menu to reveal the options.


You can specify an alternative Markdown processor, select which file extensions will be considered for inclusion, select which file patterns can be used to ignore certain files and setup the external applications that can be accessed by this plugin.

Clone this wiki locally