Added FAQ entry (about slow regeneration times)

01-start/05-faq.html.md

@@ -3,10 +3,12 @@ title: "FAQ"
 ```
 
 ## Does it work on windows?
+
 Sure does. [Install it now.](/docpad/install)
 
 
 ## What is markup?
+
 Whenever we write something we're using markup. It's merely a way of formatting content. For instance, if we are writing a `.txt` file in notepad, we will be using `plain-text` as the markup. But say we want to get more advanced, and add things like **bold** text or _italic_ text to our content, then we could use a markup like `Microsoft Word (.doc)`, `Rich Text Format (.rtf)` or simply `Markdown (.md)` or `HTML (.html)`. These markups allow us to express our content with rich formatting.
 
 For instance, **bold** in Markdown is `**bold**`, where in HTML it is `<strong>bold</strong>`. The markup that you choose for your content is highly dependent on what content you'd like to write. If you're mostly dealing with structural data (like a page layout) then `HTML`, `Jade`, `HAML`, or `CoffeeKup` would be a good way to go. If you're mostly dealing with textual data (like a blog post) then `Markdown` would probably the way to go.
@@ -17,6 +19,7 @@ DocPad currently only supports rendering plain-text formats, meaning that render
 
 
 ## What is a templating engine?
+
 Often at times we will write documents which start seeming a bit repetitive, or we would like to add a bit of dynamicness to our document. Templating engines allow us to do this, as they allow for the insertion of logic into our chosen markup.
 
 For instance, if I wanted to display a random number I could do the following:
@@ -29,10 +32,12 @@ This is pretty useful, as we can also do things like loops, or assign certain pa
 
 
 ## What is a layout?
+
 Layouts wrap over our documents. They are generally the most generic and re-used part of an entire website, or book for that matter. They contain generally the layout of the page, including the structural information and the meta information (used for search engines etc).
 
 
 ## What is a document's meta information/data?
+
 At the start of each document is an optional area right up the top that looks something like this
 
 ``` html
@@ -45,6 +50,7 @@ That is your document's meta data. It won't be included in the output of the doc
 
 
 ## Is a document aware of it's meta data?
+
 It sure is, if you are using eco as the rendering engine, you can totally do this:
 
 ``` html
@@ -60,10 +66,12 @@ To use eco, simply ensure that you have the extension `.eco` at the end of your
 
 
 ## What do the extensions mean?
+
 The extensions `.html.eco` means process this with Eco and render it as HTML. Alternatively, we can get pretty inventive and do something like this: `.html.md.eco` which means process this with Eco, then Markdown and finally render it as HTML.
 
 
 ## What is `findAllLive`?
+
 The querying abilities within DocPad are provided by a project called [Query-Engine](http://github.com/bevry/query-engine) which adds support for NoSQL queries to JavaScript Objects and Backbone Collections. In DocPad's case, we use Backbone for our Models, so we enhance our collections with Query-Engine to gain NoSQL querying for them.
 
 There are two methods that Query-Engine provides for querying Backbone Collections. The first is `findAll` and the second is `findAllLive`.
@@ -89,20 +97,24 @@ How can I learn more about the NoSQL queries available and the internals of Quer
 
 
 ## How do I hide a document from being rendered? E.g. a draft post.
+
 Check out the `ignored` [meta data property](/docpad/meta-data).
 
 
 ## How do I re-render a document on each request? E.g. dynamic documents.
+
 Check out the `dynamic` [meta data property](/docpad/meta-data).
 
 
 ## What are render passes?
+
 Rendering is a multi step process. First we render everything that is a standalone document, that is to say documents that do not including anything else. Once that is done, we then render all documents that include other documents. This is useful as we can render blog posts first, then render the content listings second.
 
 At times, you may have multiple levels of cross document references. For instance if document a references document B which references document C. In this case you would want to up the `renderPasses` configuration option for each amount of cross document references you have.
 
 
 ## How do I create custom 404 and 500 pages?
+
 Add a `src/documents/404.html` for 404 pages, and `src/documents/500.html` for 500 pages. If you create a dynamic page (adding the `dynamic: true` meta data header as mentioned above) your templating engine (e.g. `404.html.eco`) will also get access to `req` (the request instance), `res` (the response instance), `err` (the error that occured - for 500 errors pages only, not for 404 error pages). Allowing you to do something like this for `src/documents/500.html.md.eco`:
 
 ```
@@ -117,6 +129,7 @@ dynamic: true
 
 
 ## What data is exposed to my template engine?
+
 Templating engines are renderers for languages which support business logic. For instance, the template engine [Eco](https://github.com/sstephenson/eco) provides us with the following syntax `<% your business logic %>` or to output a variable we can use `<%=some variable%>`.
 
 As such, the data which we expose to our templating engines is called the `templateData`. [Check out the full listing of template data & helpers here.](/docpad/template-data)
@@ -125,40 +138,53 @@ For instance, to output the current document's title with eco, you would use: `<
 
 
 ## How can I use environment variables in DocPad?
+
 All environment variables are automatically available in node applications through [`process.env`](http://nodejs.org/api/process.html#process_process_env). DocPad also loads varibles from a special [environment file](/docpad/config#environment-configuration-file). To quickly override existing environment variables for a single invocation of DocPad, specify it on the command line before the `docpad` command:
 ```
 $ API_URL=localhost:1234 docpad run
 ```
 
 
 ## How do I disable certain plugins?
+
 Check out the `enabledPlugins` [configuration property](/docpad/config).
 
 
 ## How do I only enable the plugins that I actually use?
+
 Check out the `enableUnlistedPlugins` [configuration property](/docpad/config).
 
 
 ## How do I customise the configuration sent to a plugin?
+
 Check out the `plugins` [configuration property](/docpad/config).
 
 
 ## Where can I host my docpad website?
+
 [Check out our deployment section here.](/docpad/deploy)
 
 
 ## How can I get jade to render other DocPad supported markups?
+
 [Check out the usage section on the Jade Plugin.](https://github.com/docpad/docpad-plugin-jade#usage)
 
 
 ## How can I get my templating engine to render other DocPad supported markups?
+
 [Check out the text plugin.](/plugin/text/)
 
 
 ## How can I re-use particular templates again and again throughout my site?
+
 [Check out the partials plugin.](/plugin/partials/)
 
 
+## How do I make DocPad detect file changes faster?
+
+Check this [GitHub issue](https://github.com/bevry/docpad/issues/749), see if it helps. :)
+
+
 ## Want more help?
 
 - Getting errors? [Try our Troubleshooting Page](/docpad/troubleshoot)