Skip to main content

Automatic documentation website, with style and lazyness

Project description

Okdoc
=====

> Automatic documentation website, with style and laziness


Write your documentation as markdown files, a tiny yaml configuration and just
fire up *okdoc* to build a beautiful website around it, ready to deploy on
heroku.


Installation
------------

`pip` will be here for the next commit, in the meantime let's build from source

```console
$ git clone https://github.com/hackliff/okdoc
$ cd okdoc && python setup.py install
$ # ...
$ okdoc --help
```


Rules for a compliant okdoc project
---------------------------------

* An `index.html.md` in the root directory. It will be the first page on the
website

* Directories and files in `articles/` are sections and articles. A file or
directory named `awesome-part` will become `Awesome Part`.

* A well informed `project.yml`, like below

```yaml
title: Intuition Lab
name: intuition
author: Xavier Bruhiere
keywords: finance, trading, quant
description: Automated quantitative trading kit, for hackers
copyright: 2014 Xavier Bruhiere

links:
home: https://github.com/hackliff/intuition
blog: http://hivetech.github.io
about: www.google.com
signup: https://app.wercker.com/users/new

contact:
twitter: XavierBruhiere
support_email: xavier.bruhiere@gmail.com

github:
user: hackliff
repo: intuition
```


Bam
---

```console
$ okdoc build --from /path/to/the/doc --to /where/you/want
```

You're done. Test it locally:

```console
$ cd /where/you/want
$ # Remove .ruby-version, or install ruby 2.0.0-p247
$ bundle install
$ bundle exec middleman build
$ bundle exec middleman server
$ # This is even ready for heroku
```


Credits
-------

Kudos to the [wercker team](wercker.com) who initially built and open sourced
their [devcenter](devcenter.wercker.com) website !

Project details


Release history Release notifications

This version
History Node

0.0.3

History Node

0.0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
okdoc-0.0.3.tar.gz (4.6 kB) Copy SHA256 hash SHA256 Source None Mar 19, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page