logo

kramdown filter

← Back to Filter List

kramdown


Runs the kramdown markdown converter. http://kramdown.gettalong.org/

Aliases for this filter

  • kramdown

Converts from file formats:

  • .*

To file formats:

  • .html
  • .tex
  • .txt
  • .md

Available settings:

SettingDescriptionDefault
add-new-filesBoolean or list of extensions/patterns to match.False
added-in-versionDexy version when this filter was first available.1.0.5
additional-doc-filtersFilters to apply to additional documents created as side effects.{}
additional-doc-settingsSettings to apply to additional documents created as side effects.{}
argsArguments to be passed to the executable.
check-return-codeWhether to look for nonzero return code.True
clargsArguments to be passed to the executable (same as 'args').
classSubprocessExtToFormatFilter
command-stringThe full command string.%(prog)s %(format)s %(args)s "%(script_file)s"
data-typeAlias of custom data class to use to store filter output.generic
envDictionary of key-value pairs to be added to environment for runs.{}
examplesTemplates which should be used as examples for this filter.[]
exclude-add-new-filesList of patterns to skip even if they match add-new-files.[]
exclude-new-files-from-dirList of directories to skip when adding new files.[]
executableThe executable to be runkramdown
extFile extension to output.None
ext-to-format{'.html': 'html', '.md': 'kramdown', '.tex': 'latex', '.txt': 'kramdown'}
extension-mapDictionary mapping input extensions to default output extensions.None
format-specifier-o
helpHelpstring for plugin.Runs the kramdown markdown converter. http://kramdown.gettalong.org/
initial-timeout10
input-extensionsList of extensions which this filter can accept as input.['.*']
keep-originalsWhether, if additional-doc-filters are specified, the original unmodified docs should also be added.False
make-dummy-outputWhether to make a dummy output file when one is not generated and add-new-files is True.False
mkdirA directory which should be created in working dir.None
mkdirsA list of directories which should be created in working dir.[]
nodocWhether filter should be excluded from documentation.False
outputWhether to output results of this filter by default by reporters such as 'output' or 'website'.True
output-extensionsList of extensions which this filter can produce as output.['.html', '.tex', '.txt', '.md']
override-workspace-exclude-filtersIf True, document will be populated to other workspaces ignoring workspace-exclude-filters.False
path-extensionsstrings to extend path with[]
preserve-prior-data-classWhether output data class should be set to match the input data class.False
record-varsWhether to add code that will automatically record values of variables.False
require-outputShould dexy raise an exception if no output is produced by this filter?True
scriptargsArguments to be passed to the executable.
tagsTags which describe the filter.[]
timeout10
use-wdWhether to use a custom working directory when running filter.True
variablesA dictionary of variable names and values to make available to this filter.{}
varsA dictionary of variable names and values to make available to this filter.{}
version-commandCommand to call to return version of installed software.kramdown -version
windows-version-commandCommand to call on windows to return version of installed software.None
workspace-exclude-filtersFilters whose output should be excluded from workspace.['pyg']
workspace-includesIf set to a list of filenames or extensions, only these will be populated to working dir.None
write-stderr-to-stdoutShould stderr be piped to stdout?False
Filter Source Code
class Kramdown(SubprocessStdoutFilter):
    """
    Runs the kramdown markdown converter.

    http://kramdown.gettalong.org/
    """
    aliases = ['kramdown']
    _settings = {
            'added-in-version' : "1.0.5",
            'class' : 'SubprocessExtToFormatFilter',
            'executable' : 'kramdown',
            'version-command' : 'kramdown -version',
            'output' : True,
            'format-specifier' : '-o ',
            'ext-to-format' : {'.tex' : 'latex', '.html' : 'html', '.md' : 'kramdown', '.txt' : 'kramdown'},
            'input-extensions' : [".*"],
            'output-extensions' : [".html", ".tex", ".txt", ".md"],
            'require-output' : True,
            'command-string' : '%(prog)s %(format)s %(args)s "%(script_file)s"'
            }

    def command_string_args(self):
        args = self.default_command_string_args()

        fmt_specifier = self.setting('format-specifier')
        if fmt_specifier and (fmt_specifier in args['args']):
            # Already have specified the format manually.
            fmt = ''
        else:
            fmt_setting = self.setting('ext-to-format')[self.ext]
            if fmt_setting:
                fmt = "%s%s" % (fmt_specifier, fmt_setting)
            else:
                fmt = ''

        args['format'] = fmt
        return args

Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.