Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A wrapper for markdown that attaches vivid styles.
Shell
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
dist/archlinux
style
Makefile
README.md

README.md

Vivimd: vivid html from markdown

Introduction

Vivimd is a wrapper for markdown that attaches vivid styles. More styles are being added and a list of them will be maintained here:

StyleDescriptionPreview page
github (default)Github-like style. Preview
gritA grit-colored style. Preview

This README.md file is written as a markdown file so that you can use it to test vivimd. It's simple:

$ vivimd -e > readme.html

You can then open readme.html with whatever browser.

Other than using the default github style, you can specify other built-in styles or simply assign a custom css. The following code should explain it:

$ vivimd -e -s grit > readme.html

To list all built-in styles:

$ vivimd -l

Installation

You can checkout vivid and install it manually:

$ git clone https://github.com/peterfyj/vivimd.git vivimd
$ cd vivimd
# make install

For Archlinux users, vivimd is available through AUR, and can be installed through yaourt:

$ yaourt -S vivimd

Examples

This section contains more use of markdown for testing purposes.

Note: some markdown syntax are already covered above:

  • Hyper links;
  • Code blocks;
  • Headers;

Additionally, some styles are added for better presenting of HTML tags:

  1. <table>;
  2. <tr>;
  3. <th>;
  4. <td>;
  5. Others;

Note also that this note can be nested.

Header 3

The above is header 3.

Header 4

The above is header 4.

Header 5

The above is header 5.

Header 6

The above is header 6. Who is likely to use header 6? I don't know.

Okay, enough headers. Let's make a separating line here.


Thanks for your attention!

Where to get the code by the way?

It is here:

Github

Something went wrong with that request. Please try again.