Laravel 5 markdown parser
This is Laravel 5 package for parsing markdown files or strings. Supports booth Traditional Markdown and Github Flavored Markdown syntaxes., (*1)
Table of content
Back to top, (*2)
Todo
- Fix incoming bugs
- Finish documentation
Back to top, (*3)
Features
- Supports Traditional and GFM markdown syntax
- Easy to add new rules and skins
Back to top, (*4)
Installation
Via composer run following command in your project root:, (*5)
composer require vi-kon/laravel-markdown-parser
In your Laravel 5 project add following lines to app.php:, (*6)
// to your providers array
'ViKon\ParserMarkdown\ParserMarkdownServiceProvider',
Back to top, (*7)
Usage
First need to create classes and set markdown rules:, (*8)
$parser = new Parser();
$lexer = new Lexer();
$renderer = new Renderer();
// Initialize parser with markdown rules
$ruleSet = new MarkdownRuleSet();
$ruleSet->init($parser, $lexer);
After it need to set renderer. There are multiple skins, bootstrap and markdown., (*9)
// Set bootstrap renderer
$bootstrapSkin = new BootstrapSkin();
$bootstrapSkin->init($parser, $renderer);
// Set markdown renderer
$markdownSkin = new MarkdownSkin();
$markdownSkin->init($parser, $renderer);
The bootstrap skin outputs HTML content with Bootstrap tags and styles., (*10)
The markdown skin simply outputs markdown content. So this is mainly for testing purposes., (*11)
Syntax
Paragraphs and Line breaks
The paragraph handling is depending which parser role is set (traditional or gfm)., (*12)
If parser mode is traditional then paragraph is simply one or more consecutive lines of text, separated by one or more blank lines., (*13)
If parser mode is gfm then above rule is apply, but single newline open separate line in same paragraph., (*14)
```no-highlight
Here's a line for us to start with., (*15)
This line is separated from the one above by two newlines, so it will be a separate paragraph., (*16)
This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the same paragraph., (*17)
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a **separate paragraph**.
This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the **same paragraph**.
---
[Back to top][top]
#### Headers
Markdown support two header types (setext or atx).
```no-highlight
# H1
## H2
### H3
#### H4
##### H5
###### H6
H1
H2
H3
H4
H5
H6
Alternatively, for H1 and H2, an underline-ish style:, (*18)
```no-highlight, (*19)
Alt-H1
Alt-H2
```, (*20)
Alt-H1
Alt-H2
Back to top, (*21)
License
This package is licensed under the MIT License, (*22)
Back to top, (*23)
Wallogit.com
