rhythm.css

August 28, 2014 · View on GitHub

:version: 0.62

..

**r**\st **h**\tml **th**\e\ **\m**\e

-- rhythm.css

A css theme focus on reading, for rst document.

.. figure:: https://github.com/Rykka/github_things/raw/master/image/rst_quick_start.gif :align: center

riv.vim_ (vim) +  InstantRst_ (web server) +  rhythm.css_ (theme)

Syntax Preview__
RAW: Syntax rst file_

Article Preview__
RAW: Article rst file_

__ http://rykka.github.io/rhythm.css/rst_syntax __ http://rykka.github.io/rhythm.css/article

Post issues_ or fork it if needed.

Details

::

.
├── less
│   ├── docutils.less
│   ├── *.less
├── dist
│   └── css
│       └── rhythm.css
├── doc
│   ├── rst_syntax.rst
│   └── *.rst
├── syntax
│   ├── default.css
│   ├── *.css
│   └── murphy.css
├── Gruntfile.js
└── README.rst

less/*.less The source code

dist/css/rhythm.css Css file ready for use

Optimized for better reading, And rst syntax ready.

doc/*.rst A rst document with most rst syntax item. Use to test css with rst converted html file.

syntax/*.css Theme for pygment's syntax highlight.

You can use them in generate commands.

Gruntfile.js Build and testing commands included.

First install with ``npm install``,
Then build and test with ``grunt``.

Usage

  1. Install tool

.. code:: sh

sudo pip install docutils pygments

  1. Download

.. code:: sh

git clone https://github.com/Rykka/rhythm.css.git cd rhythm.css

  1. Generate Html

.. code:: sh

rst2html.py /path/to/your/rst
--stylesheet=rhythm.css,syntax/molokai.css
--syntax-highlight=short
> /path/to/the/output_html

This theme is build for riv.vim_, You can use it if you are writing rst document in vim.

And you can find rst specification_ and directives_ here too.

TODO

  • 2014-08-15 Add less support.
  • Add bare html support.
  • Add more themes.
  • optimize for chinese.

.. _riv.vim: http://github.com/rykka/riv.vim .. _issues: https://github.com/Rykka/rhythm.css/issues .. _fork: https://github.com/Rykka/rhythm.css .. _Syntax rst file: http://rykka.github.io/rhythm.css/doc/rst_syntax.rst .. _Article rst file: http://rykka.github.io/rhythm.css/doc/wired_article.rst .. _specification: http://rykka.github.io/rhythm.css/specification .. _directives: http://rykka.github.io/rhythm.css/directives .. _rhythm.css: http://github.com/Rykka/rhythm.css .. _InstantRst: https://github.com/Rykka/InstantRst