Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digitalmoksha/motion-kramdown
kramdown Markdown parser, for use with RubyMotion on iOS and OS X
https://github.com/digitalmoksha/motion-kramdown
kramdown motion-kramdown rubymotion
Last synced: 29 days ago
JSON representation
kramdown Markdown parser, for use with RubyMotion on iOS and OS X
- Host: GitHub
- URL: https://github.com/digitalmoksha/motion-kramdown
- Owner: digitalmoksha
- License: other
- Created: 2015-03-07T15:13:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-07-05T22:18:47.000Z (over 4 years ago)
- Last Synced: 2024-04-25T10:42:58.276Z (7 months ago)
- Topics: kramdown, motion-kramdown, rubymotion
- Language: Ruby
- Size: 495 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# motion-kramdown
[](http://badge.fury.io/rb/motion-kramdown)
[](https://travis-ci.org/digitalmoksha/motion-kramdown)
[](https://shields.io/)
[](http://www.rubymotion.com)
[kramdown](https://github.com/gettalong/kramdown) Markdown parser, for use with RubyMotion on iOS and macOS.
Currently implements: _kramdown_ 1.16.2
## Introduction
_kramdown_ is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.
The syntax definition for the kramdown syntax can be found online at and a quick reference is available online at .
The _kramdown_ library is mainly written to support the kramdown-to-HTML conversion chain. However, due to its flexibility (by creating an internal AST) it supports other input and output formats as well. Here is a list of the supported formats:
* input formats: kramdown (a Markdown superset), Markdown, GFM, HTML
* output formats: HTML, kramdown (and LaTeX and PDF, though not in _motion-kramdown_)
All the documentation on the available input and output formats is available online at .
## Installation
Add it to your project's `Gemfile`
gem 'motion-kramdown'
Edit your `Rakefile` and add
require 'motion-kramdown'
## Usage
_motion-kramdown_ uses the same api and options as _kramdown_
```ruby
Kramdown::Document.new(text).to_html
```
For detailed information on usage and options, see the [kramdown documentation](http://kramdown.gettalong.org/documentation.html). The full kramdown RDoc documentation is available at
## Supported Features
The entire kramdown api is supported, except where noted below.
### Missing Features
These items are currently not supported
1. transliterated header ids
2. math engines: MathJax, Ritex, and itex2MML
3. syntax highlighters: Coderay and Rouge
4. Latex
5. PDF
6. using template files or the :template option
7. Andriod support (will accept pull requests)
## Testing
Test files are located in the `spec` directory. The `test` directory contains the original kramdown test and data files, which are used in the specs.
#--- run the entire test suite
rake spec
#--- run just the kramdown converter tests
rake spec files=kramdown_to_xxx
#--- run test for specific data files
rake spec files=kramdown_to_xxx focus=block/03_paragraph
## Issues
If you run into any problems with the gem,
1. First see if the problem exists with the regular _kramdown_ gem. If it does, then the issue should be opened on the [main kramdown repository](https://github.com/gettalong/kramdown)
2. Open an issue on this repository
## Credit
All credit for _kramdown_ belongs to Thomas Leitner. _motion-kramdown_ is a simple modifcation to make it work with RubyMotion.
## License
_motion-kramdown_ is released under the MIT license (see the **COPYING** file) and therefore can easily be used in commercial projects.
However, if you use _motion-kramdown_ in a commercial setting, please consider **contributing back any changes** for the benefit of the community and/or
[**becoming a patron**](https://www.patreon.com/gettalong) - thanks!