Markdown
Opening
This group opens an existing Markdown file and loads it into the workflow, so the instructions that follow can read and change it. Without it a workflow could only start from the empty document made by Create Markdown.
Prerequisite: none. This is an entry-point instruction: it does not need a document to
exist in the workflow beforehand — it brings one in by reading a file from disk. A workflow
that analyses or edits an .md you already have begins here instead of with Create
Markdown.
These concepts are explained here once.
- The file to open (the source): the
.mdfile that is read from disk. If it is left empty, the instruction does nothing and no document is loaded. - ⚠ Name and Path (the destination to save to) — leaving both empty overwrites the file you opened: where the opened Markdown will be
written when you save it later. Leave them both empty and it saves over the file you opened;
fill them in and it is a save as. Whatever you leave empty is taken from the source, so a
File path on its own keeps the original file name, and a File name on its own keeps its
folder.
The file name is inherited whole, extension included: opening
notes.logand leaving the destination empty writes overnotes.logitself. A File name you type is a name without extension, so that one takes the format’s own. - Document: the Document key names the opened document so later instructions can target it. If you leave it empty, the opened Markdown becomes the current document.
- Dynamic values
@name: every field in this group is a text field, so all of them accept a saved value: type@followed by its name and the value is substituted when the workflow runs. - Nothing is written when the file is opened. The Markdown is read into memory and only reaches the disk when a save instruction runs, at the destination given by File name and File path.
Open Markdown
Opens an existing Markdown file (.md) from disk and makes it the document the workflow
works on. Its whole content is loaded, so the Analysis and Editing instructions can work on
text that was written elsewhere.
When to use it: to inspect or rewrite a Markdown document you already have — list its headings, check its links, replace a piece of text, convert it to HTML — instead of building one from scratch.
| Parameter | Meaning | Default | Required |
|---|---|---|---|
| File to open | The .md file to read from disk (accepts @name) |
(empty) | Yes |
| File name | File name the opened Markdown will be saved under; empty = the name of the file you opened (accepts @name) |
(empty) | No |
| File path | Folder the opened Markdown will be saved to; empty = the folder of the file you opened (accepts @name) |
(empty) | No |
| Document key | Names the opened document so later instructions can target it. Empty = current document (accepts @name) |
(empty) | No |
Important behavior: if File to open is empty, nothing happens and no document is loaded. The text is read as UTF-8, or as the encoding announced by a byte-order mark at the start of the file. The file is read once and then let go, so the original is never held open while the workflow runs, and it is rewritten only if the destination points back at it — which is what leaving File name and File path empty does. If the file does not exist, the workflow stops with an error. If the name in Document key is already in use by another open document, the workflow stops rather than discarding that document.
This documentation is the help of the application, and it comes underCreative Commons Attribution 4.0.