Skip to content
This repository was archived by the owner on Jun 12, 2025. It is now read-only.

rubyworks/rundown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rundown¶ ↑

Website | Development

ARCHIVE NOTICE¶ ↑

This project has been archived.

RDoc itself now supports conversion to Markdown (see documention).

The need for a Javascript library to do the same is so niche, as not to warrant further developer efforts.

Everybody has moved on to Markdown anyway. You can even tell RDoc to use Markdown instead. I would not be surprised if it is now the default. I haven’t used it in a while, so 🤷.

Description¶ ↑

Rundown is a Javascript RDoc markup to HTML converter. If is based on Showdown, the javascipt Markdown library.

Development is being done feature by feature. Currently headers and links have been adapted to RDoc markup. Where possible we are keeping Markdown support so it will be a superset of RDoc making it a bit more flexible.

Please Contribute¶ ↑

The more others contribute to Rundown, the sooner full RDoc compatibility will be achieved. As I am not a markup parser expert, on my own I will only be implementing features as I need them, can figure them out, and have time to work on it. So your contributions will have a significant impact on this project.

Contributors¶ ↑

Rundown is very much a contributor’s project, so acknowledgment of everyone who has contributed are in order.

  • Thomas Sawyer

  • Corey Innis (Showdown maintainer)

  • John Fraser (Showdown originator)

Copyrights¶ ↑

Rundown is copyrighted open source software.

  • Copyright © 2011 Rubyworks

  • Copyright © 2007 John Fraser

  • Copyright © 2004 John Gruber

See NOTICE.rdoc for details.

About

Javascript RDoc Parser

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published