arno/privatebin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added new options, deprecating syntaxhighlighting

El RIDO 2015-09-12 17:59:14 +02:00
parent d97208770b
commit fe89242351
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Configuration.md

@ -22,13 +22,23 @@ The `password` option enables or disables the password feature, defaults to true
When this option is enabled, users can choose to set a password on their paste. It is used additionally to the randomly generated cipher that is part of the URL. Without the correct password the paste can't be displayed and one can't participate in the discussion (if enabled).
### syntaxhighlighting / syntaxhighlightingtheme
### formatters
The `syntaxhighlighting` option enables or disables syntax highlighting, defaults to true.
In the section `[formatter_options]` a list of enabled formats can be provided. To disable the use of a certain formatter, simply remove it from this list.
The prettify library used for this feature works well with most programming languages but also makes plain text more readable.
The option `defaultformatter` in the `[main]` section allows you to define which of the formats is preselected in the drop down. Make sure that value exists in `[formatter_options]`.
If no `syntaxhighlightingtheme` is selected the built in theme is used, which works well with the `bootstrap` ZeroBin template. For the `page` ZeroBin template we suggest using the `sons-of-obsidian`.
Already existing pastes using disabled formatters will fall back into plain text mode when displayed. Existing pastes from previous versions that did not yet have a format set will be displayed using the `defaultformatter`.
The order of the options in this section is preserved in the display of the drop down and the labels can be adjusted. Don't forget to add any newly added or changed labels to the translation files in the `i18n` directory.
### syntaxhighlightingtheme
If `syntaxhighlighting` is added to the `[formatter_options]` section, syntax highlighting (format option "Source Code") is available as a possible format. The prettify library used for this feature works well with most programming languages.
If no `syntaxhighlightingtheme` is set, the built in theme is used, which works well with the `bootstrap` ZeroBin template. For the `page` ZeroBin template we suggest using the `sons-of-obsidian` theme.
The `syntaxhighlighting` option in the `[main]` section found in version 0.20 is deprecated and will no longer be required in version 0.21.
### template