donatj/mddom

A Simple Markdown DOM

Maintainers

Details

github.com/donatj/mddom

Source

Issues

Fund package maintenance!
www.paypal.me/donatj/15
Ko Fi
donatj

Installs: 28 227

Dependents: 1

Suggesters: 0

Security: 0

Stars: 3

Watchers: 4

Forks: 0

Open Issues: 3

v0.2.0 2023-10-03 05:14 UTC

Requires

  • php: >=7.2

Requires (Dev)

MIT 8c6949e60e97d38e8eeae4ee9129fd798c7f04d8

  • Jesse Donat <donatj.woop@gmail.com>

This package is auto-updated.

Last update: 2024-11-01 07:09:40 UTC

README

Latest Stable Version License ci.yml

A Simple Easy To Use Way to Generate Markdown Using a "DOM" Like Interface

See: docs/docs.md

Requirements

  • php: >=7.2

Installing

Install the latest version with:

composer require 'donatj/mddom'

Example

<?php

use donatj\MDDom;

require __DIR__ . '/../vendor/autoload.php';

$doc = new MDDom\Document;

$doc->appendChild(new MDDom\Header("Hello World!"));
$doc->appendChild(new MDDom\Paragraph("This text is in a paragraph"));
$doc->appendChild(new MDDom\Paragraph("This text is in a separate paragraph"));

$sub = new MDDom\DocumentDepth;
$doc->appendChild($sub);

// Header Level, e.g. <h2> is determined by the depth.
$sub->appendChild(new MDDom\Header("Sub-Header!"));
$sub->appendChild(new MDDom\CodeBlock("echo 'Hello World';", 'php'));

echo $doc->exportMarkdown();

Outputs:

# Hello World!

This text is in a paragraph

This text is in a separate paragraph

## Sub-Header!

```php
echo 'Hello World';
```