binarytorch/phpdown

Code-Driven PHP Markdown Representation

v1.0 2019-07-20 07:56 UTC

This package is auto-updated.

Last update: 2020-09-20 11:22:56 UTC


README

68747470733a2f2f706870646f776e2e62696e617279746f7263682e636f6d2e6d792f696d616765732f706870646f776e2d6c6f676f2e706e67

Code-Driven PHP Markdown Representation

License Release License



overview

PHPDown

Why? (optional)

I know, it's a little bit funky to represent Markdown elements as PHP classes but let me show you the reason behind it.

Currently, I'm still actively maintaining my package Larecipe which its main purpose is writing software documentation in a very elegant and beautiful looking. However, during my daily work as software team leader, I'm required to write a lot of docs for our projects and APIs where now I feel I have to automate this process and save some time on other important things.

Therefore, I've decided to develop a new open-source tool (will be available soon) for Larecipe where you can generate docs on the fly from your tests suites without warring on updating the docs every time you add new field or remove one and this idea requires to have Markdown generated output and yeah! you can guess the rest of the story 😆 but I really think this is helpful for other cases that's why I separated as a new package for PHP.

Installation

You can install the package via composer:

composer require binarytorch/phpdown

Usage & Supported Elements

  • Heading
  • Breaks
  • Blockquote
  • Link
  • Image
  • Todo List
  • Mutations: [Strikethrough, Bold, Inline Code, Marked]
  • Code
  • Table
  • Markdown Document

See full documentation

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email saleem@binarytorch.com.my instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.