https://github.com/abgeo/gen-md

PHP Library for generating Markdown document
https://github.com/abgeo/gen-md

Last synced: about 1 year ago
JSON representation

PHP Library for generating Markdown document

• Host: GitHub
• URL: https://github.com/abgeo/gen-md
• Owner: ABGEO
• License: mit
• Created: 2019-08-29T18:07:27.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T21:40:56.000Z (about 5 years ago)
• Last Synced: 2025-03-21T22:22:23.535Z (over 1 year ago)
• Language: PHP
• Size: 12.7 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# gen-md

PHP Library for generating Markdown document

[![GitHub license](https://img.shields.io/github/license/ABGEO07/gen-md.svg)](https://github.com/ABGEO07/gen-md/blob/master/LICENSE)

[![GitHub release](https://img.shields.io/github/release/ABGEO07/gen-md.svg)](https://github.com/ABGEO07/gen-md/releases)

[![Packagist Version](https://img.shields.io/packagist/v/abgeo/gen-md.svg "Packagist Version")](https://packagist.org/packages/abgeo/gen-md "Packagist Version")

[![PHP Innovation Award August 2020 Winner](https://www.phpclasses.org/award/innovation/winner.png)](https://www.phpclasses.org/package/11759-PHP-Compose-and-generate-Markdown-documents.html)

---

## Installation

You can install this library with [Composer](https://getcomposer.org/):

- `composer require abgeo/gen-md`

    

## Usage

Include composer autoloader in your main file (Ex.: index.php)

- `require_once __DIR__ . '/../vendor/autoload.php';`

### Classes

The library has two classes:

* `\ABGEO\MDGenerator\Document` - For generating Markdown Document;

* `\ABGEO\MDGenerator\Element` - For generating Markdown element;

#### Class `Document`

Import `ABGEO\MDGenerator\Document` class.

##### Public Methods

- `addElement()` - Add element to Document content;

- `clear()` -Clear Document content;

**Note: See usage in [example.php](examples/example.php)**

#### Class `Element`

Import `ABGEO\MDGenerator\Element` class.

##### Public Methods

- `concatenateElements()` - Concatenate given elements;

- `createHeading()` - Create heading element;

- `createParagraph()` - Create Paragraph element;

- `createBreak()` - Create Line Break element;

- `createBold()` - Create Bold element;

- `createItalic()` - Create Italic element;

- `createBoldAndItalic()` - Create Bold and Italic element;

- `createBlockquote()` - Create Blockquote element;

- `createList()` - Create List element;

- `createLine()` - Create Line element;

- `createLink()` - Create Link element;

- `createImage()` - Create Image element;

**Note: See usage in [example.php](examples/example.php)**

### Exporting

The `ABGEO\MDGenerator\Document` class has `export2File()` method that takes one argument

- File path for generated document.

### Example

```php

...

// Export document to file.

$document->export2File(__DIR__ . '/generated/example.MD');

...

```

## Examples

See full example in [example.php](examples/example.php).

## Authors

* **Temuri Takalandze** - *Initial work* - [ABGEO](https://abgeo.dev)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details