Skip to content

gu-fan/rhythm.css

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rhythm.css

Version: 0.62

rst html theme

—rhythm.css

A css theme focus on reading, for rst document.

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

riv.vim (vim) + InstantRst (web server) + rhythm.css (theme)


Syntax Preview
RAW: Syntax rst file
Article Preview
RAW: Article rst file

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
sudo pip install docutils pygments
  1. Download
git clone  https://github.com/Rykka/rhythm.css.git
cd rhythm.css
  1. Generate Html
rst2html.py /path/to/your/rst \
     --stylesheet=rhythm.css,syntax/molokai.css \
     --syntax-highlight=short \
     > /path/to/the/output_html

Related

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

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

About

A theme for rst

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages