Known limitations - tttaaaa/gollum GitHub Wiki
MISCELLANEOUS
- Page filenames may contain any printable UTF-8 character except space (U+0020) and forward slash (U+002F). If you commit a page with any of these characters in the name, it will not be accessible via the web interface.
- Pages can be link/include one another with filenames but there is only a single namespace for pages, so all page filenames should be globally unique.
- Page file directory (see Configuration) works internally but still exposes the internal directory structure to end users. If, for example, page file directory is set to
my-wiki/pages, page URLs will still containmy-wiki/pages.
ASCIIDOC: DIRECTIVES
There are two ways of using AsciiDoc documents with Gollum:
- 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.
- 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.