This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
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 !
Release History

Release History

0.0.3

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
okdoc-0.0.3.tar.gz (4.6 kB) Copy SHA256 Checksum SHA256 Source Mar 19, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting