hedinfaok/site

convox.com

Convox Docs

This repo contains the source files for convox.com.

Documentation is written in Markdown (with options similar to Github's Flavor).

Jekyll is used to generate static HTML files.

Please let us know about any issues, either via issues or by emailing [email protected]

Pull requests are also welcome!

Usage

Convox and Docker are recommended.

$ git clone https://github.com/convox/site.git && cd site
$ echo DEVELOPMENT=true >> .env
$ convox start

Running directly on your host

Ruby and bundler are required.

$ bundle install
$ jekyll serve
==    Server address: http://127.0.0.1:4000/

Please send updates to documentation as Pull Requests.

Frontmatter

Each page in the documentation has a header, called frontmatter. This controls where it's displayed and its title.

e.g.

---
title: "Custom Domains"
sort: 40
---

Publishing

When a pull request is merged into the master branch of this repo, the change is automatically deployed to staging.

Then, once one of the maintainers of this repo promotes the release on the Convox production rack, it will be visible on convox.com.