2017 © Pedro Peláez
 

library markdown-builder

Markdown Builder

image

davidbadura/markdown-builder

Markdown Builder

  • Monday, May 21, 2018
  • by DavidBadura
  • Repository
  • 2 Watchers
  • 8 Stars
  • 12,702 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 3 Forks
  • 2 Open issues
  • 6 Versions
  • 17 % Grown

The README.md

Markdown Builder

Mutation testing badge Type Coverage Latest Stable Version License, (*1)

A simple helper class to create markdown., (*2)

Installation

composer require 'davidbadura/markdown-builder'

Usage

$builder = new MarkdownBuilder();

$builder
    ->h1('Markdown Builder')
    ->p('A simple helper class to create markdown.')
    ->h2('Install ' . $builder->inlineBold('this') . ' powerfull library')
    ->code("composer require 'davidbadura/markdown-builder@dev'", 'bash')
    ->h2('Todos')
    ->bulletedList([
        'write tests',
        (string)$builder
            ->block()
            ->numberedList(['A', 'B', 'C'])
        ,
        'add more markdown features'
    ]);

echo $builder->getMarkdown();

Markdown Builder
================

A simple helper class to create markdown.

Install **this** powerfull library
----------------------------------

```bash
composer require 'davidbadura/markdown-builder@dev'
```

Todos
-----
* write tests
* 1. A
  2. B
  3. C
* add more markdown features

API

The markdown builder have two kinds of elements, block and inline elements. Block elements will be buffered and you can get the markdown if you call the method getMarkdown(). All inline Elements are prefixed with inline* and you get instantly the markdown output., (*3)

Block Elements

h1

PHP-Code:, (*4)

echo (new MarkdownBuilder())->h1('Hello World')->getMarkdown();

Markdown:, (*5)

Hello World
===========

h2

PHP-Code:, (*6)

echo (new MarkdownBuilder())->h2('Hello second world')->getMarkdown();

Markdown:, (*7)

Hello second world
------------------

h3

PHP-Code:, (*8)

echo (new MarkdownBuilder())->h3('My name is...')->getMarkdown();

Markdown:, (*9)

### My name is...

p

PHP-Code:, (*10)

echo (new MarkdownBuilder())->p('paragraph')->getMarkdown();

Markdown:, (*11)

paragraph

blockquote

PHP-Code:, (*12)

echo (new MarkdownBuilder())->blockquote("Foo\nBar\nBaz")->getMarkdown();

Markdown:, (*13)

> Foo
> Bar
> Baz

bulleted list

PHP-Code:, (*14)

echo (new MarkdownBuilder())->bulletedList(['Foo', 'Bar', 'Baz'])->getMarkdown();

Markdown:, (*15)

* Foo
* Bar
* Baz

numbered list

PHP-Code:, (*16)

echo (new MarkdownBuilder())->numberedList(['Foo', 'Bar', 'Baz'])->getMarkdown();

Markdown:, (*17)

1. Foo
2. Bar
3. Baz

hr

PHP-Code:, (*18)

echo (new MarkdownBuilder())->hr()->getMarkdown();

Markdown:, (*19)

------------------------

code

PHP-Code:, (*20)

echo (new MarkdownBuilder())->code('$var = "test";', 'php')->getMarkdown();

Markdown:, (*21)

```php
$var = "test";
```

table

PHP-Code:, (*22)

echo (new MarkdownBuilder())->table(
    ['col0', 'col1'],
    [
        ['row01', 'row01'],
        ['row10', 'row11'],
    ],
    [Alignment::CENTER, Alignment::RIGHT]
)->getMarkdown();

Markdown:, (*23)

|col0|col1|
|:-:|-:|
|row01|row01|

Inline Blocks

bold

PHP-Code:, (*24)

echo (new MarkdownBuilder())->inlineBold('Hey!');

Markdown:, (*25)

**Hey!**

italic

PHP-Code:, (*26)

echo (new MarkdownBuilder())->inlineItalic('huhu');

Markdown:, (*27)

*huhu*

code

PHP-Code:, (*28)

echo (new MarkdownBuilder())->inlineCode('$var = "test";');

Markdown:, (*29)

`$var = "test";`

PHP-Code:, (*30)

echo (new MarkdownBuilder())->inlineLink('http://google.de', 'Google', 'Title');

Markdown:, (*31)

[Google](http://google.de "Title")

img

PHP-Code:, (*32)

echo (new MarkdownBuilder())->inlineImg('cat.jpg', 'Cat', 'Title');

Markdown:, (*33)

![Cat](cat.jpg "Title")

Advance features

if you need collapse blocks, you can create a new builder instance with his own clean buffer. this can you do by call block()., (*34)

PHP-Code:, (*35)

$builder = new MarkdownBuilder();
$builder->blockqoute(
    (string)$builder
      ->block()
      ->h1('Lists')
      ->bulletedList([
        'Foo',
        $builder->block()->numberedList(['A', 'B', 'C']),
        'Bar'
      ])
);

Markdown:, (*36)

>  Lists
>  =====
>
>  * Foo
>  * 1. A
>    2. B
>    3. C
>  * Bar

The Versions

21/05 2018

dev-master

9999999-dev

Markdown Builder

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Avatar DavidBadura

markdown writer builder render

21/05 2018

1.0.4

1.0.4.0

Markdown Builder

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Avatar DavidBadura

markdown writer builder render

10/06 2015

1.0.3

1.0.3.0

Markdown Builder

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Avatar DavidBadura

markdown writer builder render

17/03 2015

1.0.2

1.0.2.0

Markdown Builder

  Sources   Download

MIT

The Requires

  • php >=5.4.0

 

The Development Requires

by Avatar DavidBadura

markdown writer builder render

26/02 2015

1.0.1

1.0.1.0

Markdown Builder

  Sources   Download

MIT

The Requires

  • php ~5.4

 

The Development Requires

by Avatar DavidBadura

markdown writer builder render

24/12 2014

1.0.0

1.0.0.0

Markdown Builder

  Sources   Download

MIT

The Requires

  • php ~5.4

 

The Development Requires

by Avatar DavidBadura