bootstraparse/workflow-documents/specs.yaml

160 lines
3.2 KiB
YAML

# Enhanced text
italics:
bpr: '*italics*'
markdown compatible: yes
additional unsupported markdown syntax: '_italics_'
accepts arguments: no
type: enhanced text
scope: first release
bold:
bpr: '**bold**'
markdown compatible: yes
accepts arguments: no
type: enhanced text
scope: first release
strikethrough:
bpr: '~~strikethrough~~'
markdown compatible: yes
accepts arguments: no
type: enhanced text
scope: first release
underline:
bpr: '__underline__'
markdown compatible: -
accepts arguments: no
type: enhanced text
scope: first release
# In-line elements
hyperlinks:
bpr: '[text]("hyperlink")'
markdown compatible: yes
accepts arguments: no
type: in-line
scope: first release
# Pre-parsing elements
aliases:
bpr: '@[alias]'
markdown compatible: -
accepts arguments: yes
type: pre-parsing
scope: first release
images:
bpr: '@{image}'
markdown compatible: no
accepts arguments: yes
type: pre-parsing
scope: first release
# One-line elements
headers:
bpr: '# header #'
markdown compatible: no
accepts arguments: yes
accepts enhanced text: no
type: one-line
scope: first release
display:
bpr: '! header !'
markdown compatible: -
accepts arguments: yes
accepts enhanced text: no
type: one-line
scope: first release
# Not sure about sublists for the moment, add that later
numbered lists:
bpr: '#. nbd list item'
markdown compatible: no
accepts arguments: no
accepts enhanced text: yes
type: one-line
scope: first release
bullet lists:
bpr: '- list item'
markdown compatible: yes
accepts arguments: no
accepts enhanced text: yes
type: one-line
scope: first release
# Multi-line elements
structural elements:
bpr: '<<start /// end>>'
accepted elements: div, article, aside, section
markdown compatible: -
accepts arguments: yes
type: multi-line
scope: first release
tables:
bpr: '| table cell |'
markdown compatible: -
accepts arguments: yes
accepts enhanced text: yes
type: multi-line
scope: first release
table-separator:
bpr: '|-----------|'
# accepts ':' either at the start, middle or end of the line to align text for the column
# putting a separator after a row will change said row to table-header
# putting a separator after a column will change said column to table-header
markdown compatible: -
accepts arguments: yes
accepts enhanced text: yes
type: multi-line
scope: first release
# # Things to add
blockquotes:
bpr: '> quote'
markdown compatible: yes
accepts arguments: yes
accepts enhanced text: yes
type: one-line
scope: first release
code:
bpr: '`quote`'
markdown compatible: yes
accepts arguments: no
accepts enhanced text: no
type: in-line
scope: post-release
code-blocks:
bpr: '```quote```'
markdown compatible: yes
accepts arguments: yes
accepts enhanced text: no
type: multi-line
scope: post-release
horizontal rule:
bpr: '---'
markdown compatible: yes
accepts arguments: yes
accepts enhanced text: no
type: one-line
scope: first release
reference-style link:
bpr: '[digit]("hyperlink")'
markdown syntax: '[link][digit]' # needs testing, unclear
accepts arguments: yes
accepts enhanced text: no
type: one-line
scope: first release
# Inline-style link with title