53adff6787cd

d: Update site.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 23 Jan 2012 20:05:00 -0500
parents c2ccda2aa728
children 270d9449963a
branches/tags (none)
files d/faqs/index.html

Changes

--- a/d/faqs/index.html	Mon Jan 23 19:38:49 2012 -0500
+++ b/d/faqs/index.html	Mon Jan 23 20:05:00 2012 -0500
@@ -18,7 +18,8 @@
 <li><a href="#can-i-have-syntax-highlighting-for-code-snippets">Can I have syntax highlighting for code snippets?</a></li>
 <li><a href="#can-i-add-html-into-the-head62-of-the-docs">Can I add HTML into the &lt;head&gt; of the docs?</a></li>
 </ul></li>
-<li><a href="#writing-tools">Writing Tools</a><ul><li><a href="#can-i-make-d-auto-rerender-when-my-files-change">Can I make d auto-rerender when my files change?</a></li>
+<li><a href="#writing-tools">Writing Tools</a><ul><li><a href="#how-can-i-preview-the-documentation-locally">How can I preview the documentation locally?</a></li>
+<li><a href="#can-i-make-d-auto-rerender-when-my-files-change">Can I make d auto-rerender when my files change?</a></li>
 <li><a href="#kicker-is-only-for-os-x-what-about-linux">Kicker is only for OS X, what about Linux?</a></li>
 <li><a href="#can-i-write-in-something-other-than-markdown">Can I write in something other than Markdown?</a></li>
 <li><a href="#can-i-add-auto-generated-documentation-into-ds-docs">Can I add auto-generated documentation into d's docs?</a></li>
@@ -86,6 +87,18 @@
 <h3 id="can-i-add-html-into-the-head62-of-the-docs">Can I add HTML into the &lt;head&gt; of the docs?</h3>
 <p>Not yet, but it's on my radar.</p>
 <h2 id="writing-tools">Writing Tools</h2>
+<h3 id="how-can-i-preview-the-documentation-locally">How can I preview the documentation locally?</h3>
+<p>You need a real web server to preview the generated files effectively.  Luckily,
+you already have one: Python comes with a built-in server that's great for
+viewing local files.</p>
+<p>Build your docs, then in a separate terminal:</p>
+<div class="codehilite"><pre><span class="nb">cd </span>myproject/docs
+<span class="nb">cd </span>build
+python -m SimpleHTTPServer
+</pre></div>
+
+
+<p>Now open <a href="http://localhost:8000">http://localhost:8000</a> and view your docs!</p>
 <h3 id="can-i-make-d-auto-rerender-when-my-files-change">Can I make d auto-rerender when my files change?</h3>
 <p>Yes, use <a href="https://github.com/alloy/kicker">kicker</a> to watch for changes and run
 <code>d</code>.</p>