Escribal
Back to Docs

Markdown

Editing

This group changes the content of a Markdown document: find and replace text, raise or lower a heading’s level, switch a list between bullets and numbers, turn a paragraph into a quote, wrap text as a link or as inline code, move, duplicate or delete whole blocks, tidy up whitespace, or produce an HTML version of the document. Most of these instructions rewrite the document in place; two of them only read it and save a result.

Prerequisite: the workflow must already have a Markdown document created (with Create Markdown) or opened. Every instruction here works on that open document.

These concepts recur across the instructions in this group; they are explained here once.

  • Document: indicates which document in the workflow the instruction applies to. If left empty, the current document is used. If the document doesn’t exist (or is not a Markdown/text document), the instruction simply does nothing.

  • Most of these instructions change the document in place. Two are read-only — Find Text and To HTML — they don’t touch the document, they only save a result.

  • Dynamic values @name: the text fields (such as Pattern, Search, Replacement, Heading text, Paragraph text, Text and URL) accept a saved value: type @ followed by its name and the engine substitutes the value at run time. This does not apply to numeric or yes/no fields.

  • Saving a result (Save … fields): the two read-only instructions save their output into a named value (Save count, Save HTML). If you leave that field empty, nothing is saved.

  • Blocks: several instructions (Delete Block, Duplicate Block, Move Block) work on blocks — the pieces of the document separated by blank lines, numbered starting at 1. If the block number is outside the document, the instruction does nothing.

  • “From variable” fields: the numeric fields New level and Block number each have a companion “from variable” field:

    • If you leave it empty, the number typed in the normal field is used.
    • If you fill it in with the name of a saved value, the engine ignores the normal field and reads the number from that variable.

    This is mainly for chaining instructions (for example, an earlier instruction saves a block number that Move Block then reads). If you only work with fixed values, you can ignore it. The yes/no fields (Use regex, Case sensitive, Replace all, Move up, To ordered) have no “from variable” companion.

Change Heading Level .md

Finds every heading whose text matches the one you give and changes its level (1 = top level, 6 = deepest).

When to use it: to promote or demote a section in the document’s outline without retyping it.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Heading text The exact text of the heading(s) to change (accepts @name) (empty) Yes
New level The level to set, from 1 (top) to 6 (deepest) 1 No
New level (from variable) Reads the level from a saved value (empty) No

Important behavior: headings are matched by their exact text, ignoring case; every matching heading is changed. The level is clamped to the 1–6 range. If Heading text is empty, or no heading matches, nothing changes.

Change List Style .md

Switches the document’s lists between bullets and numbers — every list in the document at once.

When to use it: to turn a bulleted list into a numbered one, or vice versa, across the whole document.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
To ordered Yes = turn bulleted lists into numbered ones; No = turn numbered lists into bulleted ones No No
To ordered (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: the change applies to the whole document. When numbering (To ordered = Yes), each separate list starts again at 1. When un-numbering, the numbers are replaced with - bullets.

Clean Whitespace .md

Tidies up the document’s spacing: removes trailing spaces, collapses runs of blank lines, turns stray tabs into spaces, and ensures the document ends with a single line break.

When to use it: to normalize a document’s formatting after several editing steps.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No

Important behavior: spaces at the end of lines are removed; three or more blank lines in a row become a single blank line; tabs inside a line become four spaces (leading indentation is preserved); the document ends with exactly one line break.

Convert Text To Inline Code .md

Wraps every occurrence of a piece of text in inline-code backticks.

When to use it: to mark a term, command or value as code wherever it appears.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Text The text to mark as inline code (accepts @name) (empty) Yes

Important behavior: text that is already inside a code span is left untouched. If Text is empty, nothing happens.

Convert Text To Link .md

Wraps every occurrence of a piece of text with Markdown link syntax pointing to a given address.

When to use it: to turn a word or phrase into a clickable link everywhere it appears.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Text The text to turn into a link (accepts @name) (empty) Yes
URL The address the link points to (accepts @name) (empty) No

Important behavior: text that is already inside a link or image is left untouched. If Text is empty, nothing happens.

Convert To Blockquote .md

Turns every paragraph that contains a given text into a quote by prefixing each of its lines with >.

When to use it: to highlight a specific paragraph as a quotation.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Paragraph text Text identifying the paragraph to quote (accepts @name) (empty) Yes

Important behavior: every paragraph that contains the text (ignoring case) is converted — the same scope as Convert Text To Link and Convert Text To Inline Code. Paragraphs are the pieces of text separated by blank lines. If Paragraph text is empty, nothing happens.

Delete Block .md

Removes a block from the document, identified by its number.

When to use it: to drop a paragraph, list or other block you no longer want.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Block number The number of the block to delete (blocks start at 1) 1 No
Block number (from variable) Reads the block number from a saved value (empty) No

Important behavior: blocks are the pieces separated by blank lines. If the block number is outside the document, nothing happens.

Duplicate Block .md

Makes a copy of a block and inserts it immediately after the original.

When to use it: to repeat a paragraph, list or other block as a starting point for new content.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Block number The number of the block to duplicate (blocks start at 1) 1 No
Block number (from variable) Reads the block number from a saved value (empty) No

Important behavior: the copy is placed right after the original. If the block number is outside the document, nothing happens.

Find Text .md

Searches the document for a piece of text (or a pattern) and saves how many times it occurs. This instruction only reads; it does not change the document.

When to use it: to count occurrences of a word or pattern, or to decide with a later instruction whether the document contains something.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Pattern The text to look for (accepts @name) (empty) Yes
Use regex Yes = treat the pattern as a regular expression; No = search for the literal text No No
Case sensitive Yes = match upper/lower case exactly; No = ignore case No No
Use regex (from variable) Reads the yes/no value from a saved value (empty) No
Case sensitive (from variable) Reads the yes/no value from a saved value (empty) No
Save count Name under which the number of matches is saved. Empty = don’t save (empty) No

Important behavior: if the pattern is empty, nothing happens. With Use regex on, an invalid pattern is ignored (nothing is saved). Only the match count is saved.

Move Block .md

Moves a block up or down by one position, identified by its number.

When to use it: to reorder a paragraph, list or other block within the document.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Block number The number of the block to move (blocks start at 1) 1 No
Move up Yes = move the block up one position; No = move it down Yes No
Block number (from variable) Reads the block number from a saved value (empty) No
Move up (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: blocks are the pieces separated by blank lines. If the block number is outside the document, or the block is already at the top (when moving up) or the bottom (when moving down), nothing happens.

Replace Text .md

Replaces occurrences of a piece of text (or a pattern) with another, and saves how many replacements were made.

When to use it: to correct or update wording throughout the document, or to swap a placeholder for a real value.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Search The text to find (accepts @name) (empty) Yes
Replacement The text to put in its place (accepts @name) (empty) No
Replace all Yes = replace every occurrence; No = replace only the first Yes No
Use regex Yes = treat Search as a regular expression; No = search for the literal text No No
Case sensitive Yes = match upper/lower case exactly; No = ignore case No No
Replace all (from variable) Reads the yes/no value from a saved value (empty) No
Use regex (from variable) Reads the yes/no value from a saved value (empty) No
Case sensitive (from variable) Reads the yes/no value from a saved value (empty) No
Save count Name under which the number of replacements is saved. Empty = don’t save (empty) No

Important behavior: if Search is empty, nothing happens. With Use regex on, an invalid pattern is ignored (the document is left unchanged). Leaving Replacement empty deletes the found text.

To Html .md

Renders the current Markdown to HTML and saves it. This instruction only reads; it does not change the document.

When to use it: to obtain an HTML version of the document to store or pass to another instruction.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Save HTML Name under which the HTML is saved. Empty = don’t save (empty) No

Important behavior: the document itself is not changed; only the generated HTML is saved (when Save HTML is filled in).

This documentation is the help of the application, and it comes underCreative Commons Attribution 4.0.