Documentation

Your first site

Create a documentation site, write a page and publish it.

On this page 5

Click New site on the Overview or the Sites page. The wizard asks a few questions and your site is live as soon as you finish.

1. Choose where you'll write

  • Write in the editor: create and publish pages in the browser. This is the quickest way to start.
  • Sync from a GitHub repo: your markdown stays in the repository and every push updates the site. See GitHub sync.

2. Name it and pick an address

Give the site a Site name, then choose where it should live:

  • Free subdomain: an address like yoursite.maddiedocs.com, with SSL included. Type the subdomain you want and the wizard tells you whether it's available. Subdomains use lowercase letters, numbers and hyphens.
  • Custom domain: your own address, such as docs.yourcompany.com. This needs a paid plan and a couple of DNS records. Your site is live on its free subdomain while the domain is set up. See Custom domains.

Some subdomains, such as www, docs and admin, are reserved and can't be used.

3. Create it

Check the summary and click Create site. An editor site opens straight in the editor; a GitHub site opens on its site page and starts syncing.

4. Write and publish a page

  1. In the editor, click New, give the page a title and click Create page.
  2. Write. Your work saves automatically as a draft every second or so.
  3. Click Publish. The page is now live on your site.

Click View live to see it. Drafts never appear on the live site until you publish them, so you can take your time. See Drafts and publishing.

Where to next