Internal links resolve case-insensitively, will treat spaces as hyphens, and will match the first page found with a certain filename, anywhere in the repository. Set the default keybinding for the editor. :heart:) except when the leading colon is backslashed (e.g. Use _Template in root as a template for new pages. Only overrides templates that exist in this directory. Specify custom mustache template directory. If not specified, uses the file from repository root. Specify path to a custom MathJax configuration. Can be set to gravatar, identicon or none. Tell Gollum to use specific user icons for history view. Tell Gollum to use the first as page title. Launch Gollum in "console mode", with a predefined API. 5Įnable support for annotations using CriticMarkup. By default, uses the TeX-AMS-MML_HTMLorMML config with the autoload-all extension. 4Įnables MathJax (renders mathematical equations). If set to page, Gollum will store each upload at the currently edited page. If set to dir, Gollum will store all uploads in the /uploads/ directory in repository root. Default: false.įollow pages across renames in the History view. Use the browser's local timezone instead of the server's for displaying dates. Tell Gollum to inject custom JS into each page. Tell Gollum to inject custom CSS into each page. Defaults to false in development/test, true in production/staging. If set, Gollum will only serve pages from this directory and its subdirectories. Setting this to /wiki will make the wiki accessible under Default: /. Specify the leading portion of all Gollum URLs (path info). Launch Gollum using a specific git adapter. Tell Gollum that the git repository should be treated as bare. Specify path to Gollum's configuration file. Specify the hostname or IP address to listen on. Gollum comes with the following command line options: Option To see an example and an explanation, navigate over here. With a bit of tweaking, this adds basic user-support to Gollum. Gollum can also be run alongside a CAS (Central Authentication Service) SSO (single sign-on) server. Gollum can also be run with any rack-compatible web server. See here for instructions on how to use custom rendering gems and set custom options. Just gem install the renderer of your choice. The first installed renderer from the list will be used (e.g., redcarpet will NOT be used if github/markdown is installed). This includes CommonMark support via the commonmarker gem. However, you can use any Markdown renderer supported by github-markup. Note that Gollum will also need you to install docutils for pythonīy default, Gollum ships with the kramdown gem to render Markdown.ReStructuredText - requires python >= 3.Lower versions should install Pod::Simple from CPAN.Pod - requires Perl >= 5.10 (the perl command must be available on your command line).You can easily activate support for other markups by installing additional renderers (any that are supported by github-markup): Markdown (see below for more information on Markdown flavors).It presently ships with support for the following markups: Gollum allows using different markup languages on different wiki pages. See below for information on running Gollum from source, as a Rack app, and more. See here for instructions on how to run Gollum via Docker.
0 Comments
Leave a Reply. |