summary refs log tree commit diff
path: root/nixos/modules/services/misc/gitit.nix
diff options
context:
space:
mode:
authorEdward Tjörnhammar <ed@cflags.cc>2015-08-03 22:27:43 +0200
committerEdward Tjörnhammar <ed@cflags.cc>2015-08-03 22:29:30 +0200
commit6d23f43b30e9bf0abc3d0d33cede022e8edc9ffb (patch)
tree0707917f44595d98f855de31af7785342371b946 /nixos/modules/services/misc/gitit.nix
parent4802a277a4874cf1c4971005634abb48a8d16b79 (diff)
downloadnixpkgs-6d23f43b30e9bf0abc3d0d33cede022e8edc9ffb.tar
nixpkgs-6d23f43b30e9bf0abc3d0d33cede022e8edc9ffb.tar.gz
nixpkgs-6d23f43b30e9bf0abc3d0d33cede022e8edc9ffb.tar.bz2
nixpkgs-6d23f43b30e9bf0abc3d0d33cede022e8edc9ffb.tar.lz
nixpkgs-6d23f43b30e9bf0abc3d0d33cede022e8edc9ffb.tar.xz
nixpkgs-6d23f43b30e9bf0abc3d0d33cede022e8edc9ffb.tar.zst
nixpkgs-6d23f43b30e9bf0abc3d0d33cede022e8edc9ffb.zip
nixos: gitit service, use proper documentation formatting in examples
Diffstat (limited to 'nixos/modules/services/misc/gitit.nix')
-rw-r--r--nixos/modules/services/misc/gitit.nix20
1 files changed, 9 insertions, 11 deletions
diff --git a/nixos/modules/services/misc/gitit.nix b/nixos/modules/services/misc/gitit.nix
index 28c7396672d..83186f63c2c 100644
--- a/nixos/modules/services/misc/gitit.nix
+++ b/nixos/modules/services/misc/gitit.nix
@@ -292,14 +292,10 @@ let
       plugins = mkOption {
         type = types.path;
         description = ''
-          Specifies a list of plugins to load.  Plugins may be specified either
-          by their path or by their module name.  If the plugin name starts
+          Specifies a list of plugins to load. Plugins may be specified either
+          by their path or by their module name. If the plugin name starts
           with Gitit.Plugin., gitit will assume that the plugin is an installed
           module and will not try to find a source file.
-          Examples:
-          plugins: plugins/DotPlugin.hs, CapitalizeEmphasisPlugin.hs
-          plugins: plugins/DotPlugin
-          plugins: Gitit.Plugin.InterwikiLinks
         '';
       };
 
@@ -355,7 +351,9 @@ let
           line of the file should contain two fields, separated by whitespace.
           The first field is the mime type, the second is a file extension.
           For example:
-          video/x-ms-wmx                    wmx
+<programlisting>
+video/x-ms-wmx  wmx
+</programlisting>
           If the file is not found, some simple defaults will be used.
         '';
       };
@@ -482,7 +480,7 @@ let
         default = null;
         description = ''
           The base URL of the wiki, to be used in constructing feed IDs and RPX
-          token_urls.  Set this if use-feed is 'yes' or authentication-method
+          token_urls.  Set this if useFeed is false or authentication-method
           is 'rpx'.
         '';
       };
@@ -494,7 +492,7 @@ let
           Make wikilinks absolute with respect to the base-url.  So, for
           example, in a wiki served at the base URL '/wiki', on a page
           Sub/Page, the wikilink '[Cactus]()' will produce a link to
-          '/wiki/Cactus' if absolute-urls is 'yes', and a relative link to
+          '/wiki/Cactus' if absoluteUrls is true, and a relative link to
           'Cactus' (referring to '/wiki/Sub/Cactus') if absolute-urls is 'no'.
         '';
       };
@@ -515,7 +513,7 @@ let
         type = types.bool;
         default = false;
         description = ''
-          If yes, PDF will appear in export options. PDF will be created using
+          If true, PDF will appear in export options. PDF will be created using
           pdflatex, which must be installed and in the path. Note that PDF
           exports create significant additional server load.
         '';
@@ -538,7 +536,7 @@ let
         type = types.bool;
         default = true;
         description = ''
-          If yes, all HTML (including that produced by pandoc) is filtered
+          If true, all HTML (including that produced by pandoc) is filtered
           through xss-sanitize.  Set to no only if you trust all of your users.
         '';
       };