asciidoctor

↓ examples

Runs `asciidoctor`.

Aliases for this filter

asciidoctor

Converts from file formats:

.*

To file formats:

.html
.xml
.tex

Available settings:

Setting	Description	Default
add-new-files	Boolean or list of extensions/patterns to match.	False
added-in-version	Dexy version when this filter was first available.
additional-doc-filters	Filters to apply to additional documents created as side effects.	{}
additional-doc-settings	Settings to apply to additional documents created as side effects.	{}
args	Arguments to be passed to the executable.
backend	Asciidoctor backend to use (optional, only to override default).	None
check-return-code	Whether to look for nonzero return code.	True
clargs	Arguments to be passed to the executable (same as 'args').
command-string	The full command string.	%(prog)s %(format)s %(args)s %(ss)s -o %(output_file)s %(script_file)s
data-type	Alias of custom data class to use to store filter output.	generic
env	Dictionary of key-value pairs to be added to environment for runs.	{}
examples	Templates which should be used as examples for this filter.	['asciidoctor']
exclude-add-new-files	List of patterns to skip even if they match add-new-files.	[]
exclude-new-files-from-dir	List of directories to skip when adding new files.	[]
executable	The executable to be run	asciidoctor
ext	File extension to output.	None
ext-to-format	A dict of mappings from file extensions to format parameters that need to be passed on the command line, e.g. for ghostscript .png => png16m	{'.html': 'html5', '.tex': 'latex', '.xml': 'docbook5'}
extension-map	Dictionary mapping input extensions to default output extensions.	None
format-specifier	The string used to specify the format switch, include trailing space if needed.	-b
help	Helpstring for plugin.	Runs `asciidoctor`.
initial-timeout		10
input-extensions	List of extensions which this filter can accept as input.	['.*']
keep-originals	Whether, if additional-doc-filters are specified, the original unmodified docs should also be added.	False
make-dummy-output	Whether to make a dummy output file when one is not generated and add-new-files is True.	False
mkdir	A directory which should be created in working dir.	None
mkdirs	A list of directories which should be created in working dir.	[]
nodoc	Whether filter should be excluded from documentation.	False
output	Whether to output results of this filter by default by reporters such as 'output' or 'website'.	True
output-extensions	List of extensions which this filter can produce as output.	['.html', '.xml', '.tex']
override-workspace-exclude-filters	If True, document will be populated to other workspaces ignoring workspace-exclude-filters.	False
path-extensions	strings to extend path with	[]
preserve-prior-data-class	Whether output data class should be set to match the input data class.	False
record-vars	Whether to add code that will automatically record values of variables.	False
require-output	Should dexy raise an exception if no output is produced by this filter?	True
scriptargs	Arguments to be passed to the executable.
stylesheet	Custom asciidoctor stylesheet to use.	None
tags	Tags which describe the filter.	['asciidoc', 'html']
timeout		10
use-wd	Whether to use a custom working directory when running filter.	True
variables	A dictionary of variable names and values to make available to this filter.	{}
vars	A dictionary of variable names and values to make available to this filter.	{}
version-command	Command to call to return version of installed software.	asciidoctor --version
windows-version-command	Command to call on windows to return version of installed software.	None
workspace-exclude-filters	Filters whose output should be excluded from workspace.	['pyg']
workspace-includes	If set to a list of filenames or extensions, only these will be populated to working dir.	None
write-stderr-to-stdout	Should stderr be piped to stdout?	True

Asciidoc Filter

The asciidoc filter takes asciidoc content, like this:

= Hello, AsciiDoc!
Doc Writer <doc@example.com>

An introduction to http://asciidoc.org[AsciiDoc].

== First Section

* item 1
* item 2

[source,ruby]
puts "Hello, World!"

And converts it using the asciidoc command:

- example1.adoc|asciidoctor

Custom asciidoctor stylesheets can be specified:

- example2.adoc|asciidoctor:
    - asciidoctor: { 'stylesheet' : 'readthedocs.css' }

Filter Source Code

class Asciidoctor(SubprocessExtToFormatFilter):
    """
    Runs `asciidoctor`.
    """
    aliases = ['asciidoctor']
    _settings = {
            'tags' : ['asciidoc', 'html'],
            'examples' : ['asciidoctor'],
            'output' : True,
            'version-command' : "asciidoctor --version",
            'executable' : 'asciidoctor',
            'input-extensions' : ['.*'],
            'output-extensions': ['.html', '.xml', '.tex'],
            'stylesheet' : ("Custom asciidoctor stylesheet to use.", None),
            'format-specifier': '-b ',
            'backend' : ("Asciidoctor backend to use (optional, only to override default).", None),
            'ext-to-format' : {
                '.html' : 'html5',
                '.xml': 'docbook5',
                '.tex' : 'latex'
                },
            'command-string': '%(prog)s %(format)s %(args)s %(ss)s -o %(output_file)s %(script_file)s'
            }

    def command_string_args(self):
        args = super(Asciidoctor, self).command_string_args()

        stylesheet = self.setting('stylesheet')
        if stylesheet is not None:
            stylesdir = os.path.abspath(os.path.join(os.path.dirname(__file__), 'asciidoctor'))

            if not os.path.exists(stylesdir):
                msg = "Asciidoctor stylesheet directory not found at '%s'"
                raise InternalDexyProblem(msg % stylesdir)

            args['ss'] = "-a stylesheet=%s -a stylesdir=%s" % (stylesheet, stylesdir)

            if not os.path.exists(os.path.join(stylesdir, stylesheet)):
                msg = "No stylesheet file named '%s' was found in directory '%s'. Files found: %s"
                stylesheets = os.listdir(stylesdir)
                raise UserFeedback(msg % (stylesheet, stylesdir, ", ".join(stylesheets)))

        else:
            args['ss'] = ''

        backend = self.setting('backend')
        if backend is not None:
            format_specifier = self.setting('format-specifier')
            args['format'] = "%s%s" % (format_specifier, backend)

        return args

asciidoctor filter

asciidoctor

Aliases for this filter

Converts from file formats:

To file formats:

Available settings:

Asciidoc Filter

Filter Source Code

How to

Contact Us

Quick Note

About Dexy

Dexy is a free-form literate documentation tool for writing any kind of technical document incorporating code. Dexy helps you write correct documents, and to easily maintain them over time as your code changes.

Latest News

From Twitter

Thanks To

Dexy Sponsors