| layout | title |
|---|---|
home |
Create Docs Quickly & Painlessly — No Coding Required! |
No matter how great your product, app, idea, or process is, no one will use it if they don't understand it. And the best way to help someone understand something is to create simple, helpful documentation.
But also: writing documentation sucks.
{% include figure.html src="/assets/img/docs-venn.svg" alt="writing documentation sucks Venn diagram" caption="Writing documentation is not high on my list of things to do today." border=false lightbox=false %}
That's why we're here: writing docs is awful enough without also needing to build a documentation website.
This documentation starter solves all the getting started problems, so you can just write great docs and watch the love notes roll in from your users.
Are you uncomfortable with code? No problem!
Thanks to the magic behind GitHub Pages, you can edit the entire site using the GitHub interface — no code required.
All you need to know is a few simple formatting tricks and you've got everything you need to create beautiful, user-friendly documentation.
{% include button.html href="intro/quickstart" text="Get Started in 5 Minutes" %}
Are you a developer? Never fear — this is not a nightmare CMS.
This site is powered by Jekyll, so you can easily add new partials, edit the theme, or completely modify the templates.
Most modifications will only require Markdown or Liquid templates. Styles are plain ol' CSS (with modern features enabled by PostCSS).
Nothing crazy. No databases. No complicated JavaScript. Just a simple documentation framework.
{% include button.html href="developers/overview" text="See Customization Docs" %}
{% include banners-3-col.html
b1_heading="Quickstart:
Get Up & Running in 5 Minutes"
b1_button="Read the Quickstart"
b1_link="/intro/quickstart"
b1_icon="rocket"
b2_heading="Write Pretty:<br>Learn How to Format Content"
b2_button="Content Guide"
b2_link="/content/overview"
b2_icon="sitemap"
b3_heading="Developers:<br>Put This Site on 20\" Rims"
b3_button="Developer Docs"
b3_link="/developer/overview"
b3_icon="code"
%}
{% include links-2-col.html l1_text="Request access to analytics" l1_icon="key" l1_url="#link-to-access-request" l2_text="Discuss analytics on Slack" l2_icon="slack" l2_url="#link-to-slack-channel" %}