add docs for DEBUG=express*

closes #29
expressjs · Dec 10, 2013 · f1bcc74 · f1bcc74
1 parent 0fe7cf0
commit f1bcc74
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/en/guide/debugging-express.jade b/en/guide/debugging-express.jade
@@ -0,0 +1,24 @@
+section
+  h3(id='debugging-express') Debugging Express
+
+  p.
+    Express uses the <a href="https://github.com/visionmedia/debug">debug</a> module
+    internally to log information about route matches and application mode.
+    To see this information, simply set the <code>DEBUG</code> environment variable to
+    <code>express:*</code> when launching your app and the debug information will
+    appear on the console.
+
+  +shell.
+    $ DEBUG=express:* node app.js
+
+  p.
+    Running this on the <code>hello world</code> example would print the following
+
+  +shell.
+    express:application booting in development mode +0ms
+    express:router defined get /hello.txt +0ms
+    express:router defined get /hello.txt +1ms
+
+  p.
+    For more documentation on <code>debug</code>, see the <a href="https://github.com/visionmedia/debug">debug guide</a>
+
diff --git a/en/guide/index.jade b/en/guide/index.jade
@@ -2,4 +2,5 @@ include intro
 include executable
 include error-handling
 include users-online
-include proxies
+include proxies
+include debugging-express
diff --git a/en/guide/menu.jade b/en/guide/menu.jade
@@ -5,3 +5,4 @@ ul#menu
     li: a(href='#error-handling') Error handling
     li: a(href='#users-online') Users online count
     li: a(href='#proxies') Express behind proxies
+    li: a(href='#debugging-express') Debugging Express
diff --git a/includes/mixins.jade b/includes/mixins.jade
@@ -8,6 +8,11 @@ mixin js
     code
       block
 
+mixin shell
+  pre.sh
+    code
+      block
+
 mixin logo(name)
   li
-    img(src='/images/apps/logos/#{name}.png')
+    img(src='/images/apps/logos/#{name}.png')