Getting Started

Start by initializing a new project:

inkblot init

From that, you’ll find an inkblot.yml, a .gitignore, and a pages/index.md file.

Run the development server:

inkblot dev

And visit http://localhost:3000 to see your documentation.

General Structure

Let’s take a look around your project.

First of all, the inkblot.yml file describes general information about your site, along with navigation. The default looks like this:

---
title: Documentation
nav:
- :Documentation:
  - index

If this looks a little strange for YAML, it’s the default dump output from Ruby’s Psych — you can just write normal YAML.

You’re going to want to change the site title. When you want to add a page, add its id frontmatter property to a section in the nav key.

pages/index.md should look something like this:

---
id: index
title: Home
---

# Home

Again, the id is what you’ll reference it by in the navigation, and the title will show up in the navigation and in the page title.

Just write Markdown (Kramdown-flavored) as you usually would anywhere under pages/, and use inkblot build to build the site to _build/.