summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2014-06-17 18:45:44 +0200
committerSamy Pessé <samypesse@gmail.com>2014-06-17 18:45:44 +0200
commit266f7ca73d0eeeb48d657bef625d2e00acd3d43a (patch)
tree16798ec8ca03a7288bd75a08f0e36e7defb35b04
parentd6eb8e4c6042262408c3c0b8d67bccecfa4bf882 (diff)
downloadgitbook-266f7ca73d0eeeb48d657bef625d2e00acd3d43a.zip
gitbook-266f7ca73d0eeeb48d657bef625d2e00acd3d43a.tar.gz
gitbook-266f7ca73d0eeeb48d657bef625d2e00acd3d43a.tar.bz2
Add infos about debugging
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0465754..1aed672 100644
--- a/README.md
+++ b/README.md
@@ -253,3 +253,12 @@ Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](ht
* [Markdown within HTML](https://github.com/mrpotes/gitbook-plugin-nestedmd): Process markdown within HTML blocks - allows custom layout options for individual pages
* [Bootstrap JavaScript plugins](https://github.com/mrpotes/gitbook-plugin-bootstrapjs): Use the [Bootstrap JavaScript plugins](http://getbootstrap.com/javascript) in your online GitBook
* [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik): Piwik Open Analytics tracking for your book
+
+#### Debugging
+
+You can use the environment variable `DEBUG=true` to get better error messages (with stack trace). For example:
+
+```
+$ export DEBUG=true
+$ gitbook build ./
+```