skip to navigation
skip to content

Not Logged In

hana 0.1dev

# Bloom

## Python modules
* pyyaml
* jinaj2
* markdown
* typogrify

## Configs

### site.yaml
* generator (optional; default Bloom.plugins.generators
  full class and module name of a generator. If not specified, default publisher gets used
* publisher (optional)
  full class name including module to used for publishing
* mode (optional)
  freeform, generally development, production, etc
* content_root (optional; default content)
* base_url (optional; default /)
* media_root (optional; default media)
  path is relative from content folder???
* media_url (optional; default /media)
  url where media files are served from
* output_dir (optional; default output)
* authors
  needs to have at least one author defined. Each author item needs at least name specified. Other optional parameters can be specified as desired

    authors:
        - author: mayo
              - name: Mayo Jordanov

* meta file (optional, default meta.yaml)
* meta extension (optional, default meta.yaml)
  my-article-stub.meta.yaml


### meta.yaml
* title (optional; first line of data file used as default)
* author (required)
  keyed from site.yaml authors list
* created (optional; file created date used if not specified)
  created timestamp. custom datatype with !!timestamp, can also be !!lookup, where the lookup value can be `fs` (filesystem lookup), or custom values from pluguns (mercurial, etc)
* modified (optional; file modified date used if not specified)
  modified timestamp. see notes on `created`.
* any other yaml formatted data. lower level values over overlaid on top (ie.  /content/meta.yaml[foo: test1, bar: test2], /content/dir/meta.yaml [bar: weee]. In /content, foo and bar meta values evaluate to test1 and test2 respectively. In /content/dir. foo evaluates to test1, bar evaluates to weee)


%%%%%%

- need to be able to override file extensions (article.md, .rst, etc)

%%%%%%


=========================
===========
Towel Stuff
===========

Towel Stuff provides such and such and so and so. You might find
it most useful for tasks involving <x> and also <y>. Typical usage
often looks like this::

    #!/usr/bin/env python

    from towelstuff import location
    from towelstuff import utils

    if utils.has_towel():
        print "Your towel is located:", location.where_is_my_towel()

(Note the double-colon and 4-space indent formatting above.)

Paragraphs are separated by blank lines. *Italics*, **bold**,
and ``monospace`` look like this.


A Section
=========

Lists look like this:

* First

* Second. Can be multiple lines
  but must be indented properly.

A Sub-Section
-------------

Numbered lists look like you'd expect:

1. hi there

2. must be going

Urls are http://like.this and links can be
written `like this <http://www.example.com/foo/bar>`_.
 
  • Downloads (All Versions):
  • 0 downloads in the last day
  • 0 downloads in the last week
  • 0 downloads in the last month