67ded4d11022

More FAQs.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Fri, 03 Feb 2012 18:10:11 -0500
parents 4124329cb7f6
children f97c78fac690
branches/tags (none)
files docs/04-faqs.markdown docs/footer.markdown

Changes

--- a/docs/04-faqs.markdown	Tue Jan 31 20:10:41 2012 -0500
+++ b/docs/04-faqs.markdown	Fri Feb 03 18:10:11 2012 -0500
@@ -8,18 +8,40 @@
 Should I use d for my project?
 ------------------------------
 
-If you want lots of control over the resulting documentation: no.
+If you want lots of control over the resulting documentation: **no**.
 
-If you want to hook in API docs and such: no.
+If you want to hook in API docs and such: **no**.
 
-If you want to write in something other than Markdown: no.
+If you want to write in something other than Markdown: **no**.
 
 If you have a large project and need more than one level of organization for
-your documentation: no.
+your documentation: **no**.
 
 If you have a small project and want to quickly write some docs that don't look
 like ass: **yes!**
 
+What if I Outgrow d?
+--------------------
+
+If your documentation starts to need some more structure or functionality, you
+can easily switch over to [Sphinx][] in a few minutes:
+
+1. Use [Pandoc][] to convert your Markdown to reStructuredText.  There's
+   a [web-based version][pandocweb] if you don't want to bother building
+   Haskell.
+2. Create a new Sphinx project in the usual manner.
+3. Copy your converted documentation into it.
+4. That's it.
+
+There's nothing tricky about this process because `d` has almost no
+process/configuration of its own.  All you do when using `d` is create pure
+content.  This makes switching to other tools simple a matter of converting this
+content to their preferred format.
+
+[Sphinx]: http://sphinx.pocoo.org/
+[Pandoc]: http://johnmacfarlane.net/pandoc/
+[pandocweb]: http://johnmacfarlane.net/pandoc/try
+
 Web Servers and File Layout
 ---------------------------
 
--- a/docs/footer.markdown	Tue Jan 31 20:10:41 2012 -0500
+++ b/docs/footer.markdown	Fri Feb 03 18:10:11 2012 -0500
@@ -1,5 +1,7 @@
 Created by [Steve Losh](http://stevelosh.com).  Inspired by [t](http://stevelosh.com/projects/t/).
 
+<br/><a id='rochester-made' href='http://rochestermade.com' title='Rochester Made'><img src='http://rochestermade.com/media/images/rochester-made-dark-on-light.png' alt='Rochester Made' title='Rochester Made' /></a>
+
 <script type="text/javascript">
     var _gauges = _gauges || [];
     (function() {