{"id":18352137,"url":"https://github.com/abgeo/gen-md","last_synced_at":"2025-04-06T11:32:45.331Z","repository":{"id":52413065,"uuid":"205222782","full_name":"ABGEO/gen-md","owner":"ABGEO","description":"PHP Library for generating Markdown document","archived":false,"fork":false,"pushed_at":"2021-04-29T21:40:56.000Z","size":13,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-21T22:22:23.535Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ABGEO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":"ABGEO","open_collective":"ABGEO","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.paypal.me/ABGEO"]}},"created_at":"2019-08-29T18:07:27.000Z","updated_at":"2021-09-07T23:28:57.000Z","dependencies_parsed_at":"2022-08-21T06:50:29.354Z","dependency_job_id":null,"html_url":"https://github.com/ABGEO/gen-md","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ABGEO%2Fgen-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ABGEO%2Fgen-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ABGEO%2Fgen-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ABGEO%2Fgen-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ABGEO","download_url":"https://codeload.github.com/ABGEO/gen-md/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247478152,"owners_count":20945258,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T21:34:59.500Z","updated_at":"2025-04-06T11:32:44.898Z","avatar_url":"https://github.com/ABGEO.png","language":"PHP","funding_links":["https://patreon.com/ABGEO","https://opencollective.com/ABGEO","https://www.paypal.me/ABGEO"],"categories":[],"sub_categories":[],"readme":"# gen-md\nPHP Library for generating Markdown document\n\n[![GitHub license](https://img.shields.io/github/license/ABGEO07/gen-md.svg)](https://github.com/ABGEO07/gen-md/blob/master/LICENSE)\n[![GitHub release](https://img.shields.io/github/release/ABGEO07/gen-md.svg)](https://github.com/ABGEO07/gen-md/releases)\n[![Packagist Version](https://img.shields.io/packagist/v/abgeo/gen-md.svg \"Packagist Version\")](https://packagist.org/packages/abgeo/gen-md \"Packagist Version\")\n\n[![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)\n\n---\n\n## Installation\n\nYou can install this library with [Composer](https://getcomposer.org/):\n\n- `composer require abgeo/gen-md`\n    \n## Usage\n\nInclude composer autoloader in your main file (Ex.: index.php)\n\n- `require_once __DIR__ . '/../vendor/autoload.php';`\n\n### Classes\n\nThe library has two classes:\n\n* `\\ABGEO\\MDGenerator\\Document` - For generating Markdown Document;\n* `\\ABGEO\\MDGenerator\\Element` - For generating Markdown element;\n\n#### Class `Document`\n\nImport `ABGEO\\MDGenerator\\Document` class.\n\n##### Public Methods\n\n- `addElement()` - Add element to Document content;\n- `clear()` -Clear Document content;\n\n**Note: See usage in [example.php](examples/example.php)**\n\n#### Class `Element`\n\nImport `ABGEO\\MDGenerator\\Element` class.\n\n##### Public Methods\n\n- `concatenateElements()` - Concatenate given elements;\n- `createHeading()` - Create heading element;\n- `createParagraph()` - Create Paragraph element;\n- `createBreak()` - Create Line Break element;\n- `createBold()` - Create Bold element;\n- `createItalic()` - Create Italic element;\n- `createBoldAndItalic()` - Create Bold and Italic element;\n- `createBlockquote()` - Create Blockquote element;\n- `createList()` - Create List element;\n- `createLine()` - Create Line element;\n- `createLink()` - Create Link element;\n- `createImage()` - Create Image element;\n\n**Note: See usage in [example.php](examples/example.php)**\n\n### Exporting\n\nThe `ABGEO\\MDGenerator\\Document` class has `export2File()` method that takes one argument\n- File path for generated document.\n\n### Example\n\n```php\n...\n// Export document to file.\n$document-\u003eexport2File(__DIR__ . '/generated/example.MD');\n...\n```\n\n## Examples\n\nSee full example in [example.php](examples/example.php).\n\n## Authors\n\n* **Temuri Takalandze** - *Initial work* - [ABGEO](https://abgeo.dev)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabgeo%2Fgen-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabgeo%2Fgen-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabgeo%2Fgen-md/lists"}