https://github.com/rubyworks/rundown

Javascript RDoc Parser
https://github.com/rubyworks/rundown

Last synced: 6 months ago
JSON representation

Javascript RDoc Parser

• Host: GitHub
• URL: https://github.com/rubyworks/rundown
• Owner: rubyworks
• License: bsd-3-clause
• Created: 2011-09-29T15:44:49.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2012-12-20T16:57:00.000Z (about 13 years ago)
• Last Synced: 2024-11-09T02:06:11.356Z (over 1 year ago)
• Language: JavaScript
• Homepage: http://rubyworks.github.com/rundown
• Size: 109 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
= Rundown

{Website}[http://rubyworks.github.com/rundown] |

{Development}[http://gitub.com/rubyworks/rundown]

== ARCHIVE NOTICE

This project has been archived.

RDoc itself now supports conversion to Markdown (see {documention}[https://ruby.github.io/rdoc/RDoc/Markup/ToMarkdown.html]).

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 :shrug:.

== 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 (c) 2011 Rubyworks

* Copyright (c) 2007 John Fraser

* Copyright (c) 2004 John Gruber

See NOTICE.rdoc for details.