Download the PHP package cassarco/markdown-tools without Composer
On this page you can find all versions of the php package cassarco/markdown-tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cassarco/markdown-tools
More information about cassarco/markdown-tools
Files in cassarco/markdown-tools
Package markdown-tools
Short Description A package for Laravel that lets you run Laravel Validation and/or a handler function over markdown files in your application.
License MIT
Homepage https://github.com/cassarco/markdown-tools
Informations about the package markdown-tools
markdown-tools
This is a package for Laravel that lets you run Laravel Validation and/or a handler function over markdown files in your application.
First, define one or more schemes in your configuration file. Then run the bundled command to process those schemes. Read on for more detailed instructions.
Installation
You can install the package via composer:
You can publish the config file with:
This is the contents of the published config file:
Usage
First define one or more schemes:
If you are following this example exactly, don't forget to import the info
function:
Now run the bundled command to process these schemes:
In this example you will see a list of titles for every markdown file in the folder resources/markdown
, provided that
they have a title property in the markdown's front matter.
If one or more files do not pass validation, then you will see a Laravel Validation error.
You should be able to use any of the Laravel Validation Rules that make sense in this context.
Notice that the handler makes a Markdown File $file
available to you on which you will find the following methods:
In my case, I use this package to import the markdown files into my database for https://www.carlcassar.com:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
If you find a bug that impacts the security of this package please send an email to [email protected] instead of using the issue tracker.
Credits
- Carl Cassar
- Cassar & Co
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of markdown-tools with dependencies
cassarco/league-commonmark-wikilinks Version ^1.0.2
spatie/laravel-package-tools Version ^1.14.0
symfony/dom-crawler Version ^7.0