luxuryluke / Kirby-markup

A collection of kirbytags providing advanced options for semantic markup.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Semantic Markup Kirbytags

A collection of kirbytags providing advanced options for semantic markup within textareas. Includes tags for: abbr, cite, dfn, ins, mark, q, s, samp, sub, sup. Each new tag includes a complementary textareaToolbar button.

Installation

kirby plugin:install scottboms/kirby-markup

Git submodule

git submodule add https://github.com/scottboms/kirby-markup.git site/plugins/kirby-markup

Copy and Paste

  1. Download the contents of this repository as Zip file.
  2. Rename the extracted folder to kirby-markup and copy it into the site/plugins/ directory in your Kirby project.

Usage

To utilize the buttons in textarea field, you need to add them explicitly to your blueprints. For example:

text:
  label: Content
  type: textarea
  buttons:
    - abbr
    - cite
    - dfn
    - ins
    - mark
    - q
    - s
    - samp
    - sub
    - sup

Optional Tag Attributes

All tags provide an convenience class attribute and the abbr and dfn tags also provide an optional title attribute per HTML markup standards.

  • class: A CSS class/classes to append to the element [optional]
  • title: A title attribute for abbr, dfn, and `` [optional]

(abbr: CSS title: Cascading Style Sheets class: markup__abbr)

(cite: Nineteen Eighty-Four class: markup__cite) by George Orwell

A (dfn: validator class: markup__dfn) is a program that checks for syntax errors in code or documents.

You're late! (ins: A wizard is never late class: markup__ins).

... (mark: Rebel spies managed to steal secret plans) to the Empire's ultimate weapon, the DEATH STAR ...

When Dave asks HAL to open the pod bay door, HAL answers: (q: I'm sorry, Dave. I'm afraid I can't do that.)

(s: There will be a few tickets available at the box office tonight.) SOLD OUT

(samp: Keyboard not found. Press F1 to continue. class: markup__samp)

C(sub: 8)H(sub: 10)N(sub: 4)O(sub: 2), also known as caffeine.

a(sup: 2) + b(sup: 2) = c(sup: 2)

Compatibility

  • Kirby 3.5+
  • Kirby 4+

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test before using it in a production environment. If you identify an issue, typo, etc, please create a new issue so I can investigate.

License

MIT

About

A collection of kirbytags providing advanced options for semantic markup.

License:MIT License


Languages

Language:JavaScript 54.1%Language:PHP 45.9%