yannoff/lumiere-ui

A set of laravel view components

0.3.0 2021-12-20 19:11 UTC

Requires

• php: >=7.0

Requires (Dev)

• illuminate/support: *
• illuminate/view: *

MIT

• Yannoff

• laravel
• illuminate
• lumen
• Laravel Framework

README

A set of laravel view components.

Installation

Via composer:

composer require yannoff/lumiere-ui

Reference

x-heading

Generate a heading block with an apposite anchor.

Attributes

Name	Required	Description
level	yes	The heading level (1 to 6)

Example

<x-heading level="2">
    My Heading 2
</x-heading>

will render as

<h2><a name="my-heading-2" href="#my-heading-2">My Heading 2</a></h2>

x-md

Basic renderer for simple markdown.

Supported modifiers

Here is the thorough list of the supported markdown syntax modifiers:

Type	Modifier	Example	Description
Bold	Double underscore / asterisk	**my bold text**	Wrap the text with <b> tags
Italic	Simple underscore / asterisk	_my italic text_	Wrap the text with <i> tags
Inline code	Backticks	`my code snippet`	Wrap the text with <code> tags
URLs	-	https://site.com	Wrap the URL in a <a> tag
Links	Braquets	[Site](https://site.com)	Renders a <a> tag

Example

<x-md>
    The `yannoff/lumiere-ui` component is **awesome**.
    See the [repository](https://github.com/yannoff/lumiere-ui "Lumiere Github repo").
<x-md>

will render as

The <code>yannoff/lumiere-ui</code> component is <b>awesome</b>.
See the <a href="https://github.com/yannoff/lumiere-ui" title="Lumiere Github repo">repository</a>.

License

Licensed under the MIT License.