Known limitations

MISCELLANEOUS

1. If wiki is a git submodule, then gollum will not see any files in the directory.

ASCIIDOC: DIRECTIVES

There are two ways of using AsciiDoc documents with Gollum:

1. Gollum is the only tool in your chain that renders your AsciiDoc documents. In this case, you can use the Gollum macros as added functionality to your wiki.
2. Gollum is not the only tool in your chain that renders your AsciiDoc documents (you're also using e.g. docbook) and you're using Gollum as an editor for your documents. In this case, it is imperative that you limit yourself to AsciiDoc syntax - you should not be using Gollum macros.

The Asciidoc include directive is an example of where there is also a Gollum alternative. See #1010 for current limitations.

RESTRUCTURED: INCLUDE DIRECTIVE

For example,

.. code-block:: bash
    :include: src/sample.rb

will not work because Gollum's philosophy at the moment is to provide its own facilities for things like this. In this very case, Gollum provides its own include directive.