https://github.com/rancoud/markdown

Markdown Package
https://github.com/rancoud/markdown

markdown php

Last synced: 11 months ago
JSON representation

Markdown Package

• Host: GitHub
• URL: https://github.com/rancoud/markdown
• Owner: rancoud
• License: mit
• Created: 2018-10-22T22:20:15.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-08-30T20:21:23.000Z (over 5 years ago)
• Last Synced: 2025-02-26T19:44:31.365Z (11 months ago)
• Topics: markdown, php
• Language: PHP
• Size: 120 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Markdown Package

![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/rancoud/markdown)

[![Packagist Version](https://img.shields.io/packagist/v/rancoud/markdown)](https://packagist.org/packages/rancoud/markdown)

[![Packagist Downloads](https://img.shields.io/packagist/dt/rancoud/markdown)](https://packagist.org/packages/rancoud/markdown)

[![Composer dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)](https://github.com/rancoud/markdown/blob/master/composer.json)

[![Test workflow](https://img.shields.io/github/workflow/status/rancoud/markdown/test?label=test&logo=github)](https://github.com/rancoud/markdown/actions?workflow=test)

[![Codecov](https://img.shields.io/codecov/c/github/rancoud/markdown?logo=codecov)](https://codecov.io/gh/rancoud/markdown)

[![composer.lock](https://poser.pugx.org/rancoud/markdown/composerlock)](https://packagist.org/packages/rancoud/markdown)

Markdown using [GitHub Flavored Markdown Spec](https://github.github.com/gfm/#what-is-github-flavored-markdown-).  

## Installation

```php

composer require rancoud/markdown

```

## How to use it?

```php

$m = new \Rancoud\Markdown\Markdown();

echo $m->render('*my content*');

```

## Markdown Methods

### General Commands  

* render(content: string):string

* addInlines(inlines: string):void

* removeInlines(inlines: string):void

* addBlocks(blocks: string):void

* removeBlocks(blocks: string):void

## How to Dev

`composer ci` for php-cs-fixer and phpunit and coverage  

`composer lint` for php-cs-fixer  

`composer test` for phpunit and coverage

## TODO

- [ ] test only one block rendering

- [X] list all github examples in order