Download the PHP package samwilson/commonmark-shortcodes without Composer
On this page you can find all versions of the php package samwilson/commonmark-shortcodes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download samwilson/commonmark-shortcodes
More information about samwilson/commonmark-shortcodes
Files in samwilson/commonmark-shortcodes
Package commonmark-shortcodes
Short Description Adds shortcodes to Markdown, for the CommonMark package.
License gpl-3.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package commonmark-shortcodes
Samwilson/CommonMarkShortcodes
An extension to League/CommonMark for adding 'shortcodes' to Markdown.
Shortcodes are bits of text in a Markdown document that are delimited with one or three braces and are replaced with whatever content is needed. There are two types of shortcode, inline and block (the same name cannot be used for both an inline and block shortcode; i.e. you must decide when designing the shortcodes how each is to be used).
Inline shortcodes have one brace, {name|attr=val}, and appear within a paragraph or list item etc. For example, here cite is the name of the shortcode and it's got one attribute:
Block shortcodes have three braces, {{{name|attr=val}}}, and an optional body;
their attributes are the same as for inline shortcodes.
Here quotation is the shortcode, it's got one attribute, and a two-line body:
Shortcodes can have zero or more attributes.
Attributes are separated by pipes |
and can be given a name by adding the equals sign
(without a name, they're numbered from 1).
When compiled, the shortcodes are replaced by the HTML (or other content) that is specified in the shortcode handlers. See #Usage below for more information about how to set up the CommonMark environment.
Installation
Install with Composer:
Usage
Set up your CommonMark Environment object with a shortcodes configuration key:
Then add the ShortcodeExtension, and start converting Markdown:
The callbacks are where you define your shortcodes' output.
Each takes a single parameter (a Shortcode object)
and returns a string that will be inserted into the output in place of the shortcode.
For example, Markdown like this:
could be paired with the following shortcode configuration:
to produce this output:
See the examples/ directory for functioning examples, and if you have any issues please do report them.
License
Copyright © 2023 Sam Wilson https://samwilson.id.au/
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/
