Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Make plugins flag enabled by default.

  • Loading branch information...
commit e9ac5c2ba4750104e3a663c83cd55a4e5e4d9d26 1 parent d1ef791
@jgm authored
Showing with 38 additions and 35 deletions.
  1. +34 −33 README.markdown
  2. +4 −2 gitit.cabal
View
67 README.markdown
@@ -75,25 +75,6 @@ is compiled with highlighting support, then install gitit as above:
cabal install pandoc -fhighlighting --reinstall
cabal install gitit
-Optional plugins support
-------------------------
-
-Plugins are small Haskell programs that transform a wiki page after it
-has been converted from Markdown or RST. See the example plugins in the
-`plugins` directory. To enable a plugin, include the path to the plugin
-(or its module name) in the `plugins` field of the configuration file.
-(If the plugin name starts with `Network.Gitit.Plugin.`, gitit will assume that
-the plugin is an installed module and will not look for a source file.)
-
-The gitit executable will be much larger if plugins support is compiled
-in. Plugin support is disabled by default. To enable support for
-plugins, pass the `plugins` flag to Cabal:
-
- cabal install gitit -fplugins
-
-Note also that if you compile gitit for executable profiling, attempts
-to load plugins will result in "internal error: PAP object entered!"
-
Running gitit
-------------
@@ -185,6 +166,25 @@ title
: By default the displayed page title is the page name. This metadata element
overrides that default.
+Highlighted source code
+-----------------------
+
+If gitit was compiled against a version of pandoc that has highlighting
+support (see above), you can get highlighted source code by using
+[delimited code blocks][]:
+
+ ~~~ {.haskell .numberLines}
+ qsort [] = []
+ qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
+ qsort (filter (>= x) xs)
+ ~~~
+
+To see what languages are available:
+
+ pandoc -v
+
+[delimited code blocks]: http://johnmacfarlane.net/pandoc/README.html#delimited-code-blocks
+
Configuring gitit
=================
@@ -288,24 +288,25 @@ You can write display math by enclosing it in double dollar signs:
[jsMath download page]: http://sourceforge.net/project/showfiles.php?group_id=172663
-Highlighted source code
------------------------
-
-If gitit was compiled against a version of pandoc that has highlighting
-support (see above), you can get highlighted source code by using
-[delimited code blocks][]:
+Plugins
+=======
- ~~~ {.haskell .numberLines}
- qsort [] = []
- qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
- qsort (filter (>= x) xs)
- ~~~
+Plugins are small Haskell programs that transform a wiki page after it
+has been converted from Markdown or RST. See the example plugins in the
+`plugins` directory. To enable a plugin, include the path to the plugin
+(or its module name) in the `plugins` field of the configuration file.
+(If the plugin name starts with `Network.Gitit.Plugin.`, gitit will assume that
+the plugin is an installed module and will not look for a source file.)
-To see what languages are available:
+Plugin support is enabled by default. However, plugin support makes
+the gitit executable considerably larger and more memory-hungry.
+If you don't need plugins, you may want to compile gitit without plugin
+support. To do this, unset the `plugins` Cabal flag:
- pandoc -v
+ cabal install --reinstall gitit -f-plugins
-[delimited code blocks]: http://johnmacfarlane.net/pandoc/README.html#delimited-code-blocks
+Note also that if you compile gitit for executable profiling, attempts
+to load plugins will result in "internal error: PAP object entered!"
Accessing the wiki via git or darcs
===================================
View
6 gitit.cabal
@@ -77,8 +77,10 @@ data-files: css/screen.css, css/print.css, css/ie.css, css/hk-pyg.css,
CHANGES, README.markdown, YUI-LICENSE, BLUETRIP-LICENSE, TANGOICONS
Flag plugins
- description: Compile in support for plugins.
- default: False
+ description: Compile in support for plugins. This will increase the size of
+ the executable and the memory it uses, so those who will not need
+ plugins should disable this flag.
+ default: True
Library
hs-source-dirs: .
Please sign in to comment.
Something went wrong with that request. Please try again.