tools | extract-md

author: Florian SCHMID

License: Copyright (c) 2012 Florian SCHMID, MIT License

Scriptlanguage: AutoHotkey

tags: autohotkey, documentation, tool


Description

The aim of this tool is to extract Markdown textblocks from files and merge them into a single file. The file can then be processed by a tool like Pandoc to convert it from Markdown to a HTML page for example.


Usage

  1. Setup the INI-file to fit your needs
  2. drag and drop the file(s) onto the .exe
  3. enter the name of the project (= level 1 header)
  4. enter the name of the output-file

The INI-Configuration file

The INI-File looks like this:
Filename: <Name of .exe or .ahk file>.ini

[SETUP]
BLOCK_START=<string>
BLOCK_LINE=<string>
BLOCK_END=<string>
CUSTOM_BR=<string>
BLOCK_SEP=<string>
FILE_SEP=<string>
OUTPUT=<filename>

Details

BLOCK_START
Tag for starting block.
standard value: /*md
BLOCK_LINE
If a line inside the block starts with this string it will be removed from the line.
standard value: (empty)
BLOCK_END
Tag for ending block.
standard value: */
CUSTOM_BR
If this tag is found, it will be replaced with 2 space-characters. (inducing a line-break)
standard value: -b
BLOCK_SEP
Tag that will be used to seperate 2 blocks in the output md-file.
standard value: (empty)
FILE_SEP
Tag that will be used to seperate 2 files in the output md-file.
standard value: *******************
OUTPUT
Default filename in the file-selection dialog.
standard value: output.md


Downloads

Description Link
Download from GitHub Download page
Want to contribute? Github Repository