bad650893001
d: Update site.
author | Steve Losh <steve@stevelosh.com> |
---|---|
date | Fri, 03 Feb 2012 18:05:34 -0500 |
parents | 75a884574b94 |
children | 540256c254e3 |
branches/tags | (none) |
files | d/faqs/index.html |
Changes
--- a/d/faqs/index.html Tue Jan 31 20:11:08 2012 -0500 +++ b/d/faqs/index.html Fri Feb 03 18:05:34 2012 -0500 @@ -5,6 +5,7 @@ <h1 id="faqs"><a href="">FAQs</a></h1><p>Maybe not "frequently asked", but hopefully these answers will be useful.</p> <div class="toc"> <ul><li><a href="#should-i-use-d-for-my-project">Should I use d for my project?</a></li> +<li><a href="#what-if-i-outgrow-d">What if I Outgrow d?</a></li> <li><a href="#web-servers-and-file-layout">Web Servers and File Layout</a><ul><li><a href="#do-i-need-to-do-anything-special-with-my-webserver">Do I need to do anything special with my webserver?</a></li> <li><a href="#why-does-d-use-pageindexhtml-instead-of-pagehtml">Why does d use page/index.html instead of page.html?</a></li> <li><a href="#can-i-serve-the-documentation-at-a-url-other-than">Can I serve the documentation at a URL other than /?</a></li> @@ -35,6 +36,19 @@ your documentation: no.</p> <p>If you have a small project and want to quickly write some docs that don't look like ass: <strong>yes!</strong></p> +<h2 id="what-if-i-outgrow-d">What if I Outgrow d?</h2> +<p>If your documentation starts to need some more structure or functionality, you +can easily switch over to <a href="http://sphinx.pocoo.org/">Sphinx</a> in a few minutes:</p> +<ol><li>Use <a href="http://johnmacfarlane.net/pandoc/">Pandoc</a> to convert your Markdown to reStructuredText. There's + a <a href="http://johnmacfarlane.net/pandoc/try">web-based version</a> if you don't want to bother building + Haskell.</li> +<li>Create a new Sphinx project in the usual manner.</li> +<li>Copy your converted documentation into it.</li> +<li>That's it.</li> +</ol><p>There's nothing tricky about this process because <code>d</code> has almost no +process/configuration of its own. All you do when using <code>d</code> is create pure +content. This makes switching to other tools simple a matter of converting this +content to their preferred format.</p> <h2 id="web-servers-and-file-layout">Web Servers and File Layout</h2> <h3 id="do-i-need-to-do-anything-special-with-my-webserver">Do I need to do anything special with my webserver?</h3> <p>Your webserver should add a trailing slash to directories. Most sane ones do