Course text format
A course can be written outside Linyup, in any text editor, as a folder of Markdown files: plain text with a few marks for headings, lists and links. The format matches the lesson editor, so everything you can write here becomes the same lesson you would build by hand (see Writing lessons).
Importing it
Section titled “Importing it”Zip the course folder, then in Linyup:
- A new course, or one you imported before: open Online courses and choose Import from ZIP.
- An existing course: open the course, go to Settings, and choose Update from a ZIP.
Linyup first shows what would change: new and changed lessons, the ones that stay as they are, and any you have edited in Linyup since the last import. Those are left alone unless you switch on Overwrite my changes in Linyup. Nothing is written until you press Import. A new course arrives as a draft for you to review before anyone sees it. Importing into a published course changes what members see at once, and Linyup tells you so before you import.
A lesson you removed from the folder is not deleted: Linyup names it, and you delete it in the course editor if it should go.
Translations
Section titled “Translations”Put a translation beside its original, with the language’s code before .md: 01-history.de.md beside 01-history.md, module.fr.md beside module.md, course.it.md beside course.md, terms.de.md beside terms.md. The languages are en, de, fr and it. A translation has a title and the translated text, in the same format with the same blocks; everything else (pictures, media, attachments, whether it is shown) is the original’s.
Import the course with every language in the same ZIP. Members see the course in their language where it is translated, and in the original where it is not. A translation you change in Linyup afterwards is kept when you import again, unless you switch on Overwrite my changes in Linyup.
Say which language the course is written in with language: in course.md (or Written in in the course’s settings). Members can always switch back to it, and it is never offered as a translation. Without it, Linyup takes your studio’s or organization’s language, which may not be the course’s.
You can also translate in Linyup:
- Add a language with Add language next to the language buttons, above a lesson or in the course’s Settings. Pick it, then fill it in by hand or with Translate with AI. Remove (the bin next to the buttons) deletes every translation into that language, after asking.
- A lesson: pick a language above it to read or edit its translation, or use Translate with AI there.
- The course’s title and summary: in Settings, pick a language above them, then type or use Translate with AI (it also translates the modules’ titles).
- A module’s title: edit the module; each language the course is in has its own field.
- The whole course at once: Translate with AI in Settings.
Linyup shows the price in AI credits before it translates, and never replaces a translation you wrote. The languages are English, German, French and Italian.
Exporting a course
Section titled “Exporting a course”In a course’s Settings, Export as a ZIP downloads the course as this same folder, with its pictures and attachments. Edit it anywhere and bring it back with Update from a ZIP: a course you export and import again without changes comes back exactly as it was. Who can open the course, when it is a plan or a price, stays in Linyup and is not in the folder.
The folder
Section titled “The folder”theory-course/ course.md the course: title, access, summary cover.jpg optional cover picture book-cover.jpg optional cover for the PDF book terms.md optional: the course's terms 01-introduction/ a module: a folder with a module.md module.md 01-history.md a lesson 02-principles.md img/photo.jpg pictures the lessons show 02-white-belt/ module.md 01-exam-programme.md files/handout.pdf a folder without module.md just holds files- A module is a folder with a
module.mdfile in it. Its lessons are the other.mdfiles in that folder. - A number in front of a name (
01-,02-) only sets the order. It is not part of the name, so you can renumber files freely. - Each lesson’s file name (without the number) must be different from every other lesson’s in the course.
The course: course.md
Section titled “The course: course.md”The settings go between the two --- lines at the top. The text below them is the course summary.
---title: Theory of the practitioneraccess: registered # free, or registered (members must sign in)language: en # optional: the language the course is written in (en, de, fr or it)slug: theory # optional: the course's addresscover: cover.jpg # optionalbook_cover: book-cover.jpg # optional: the PDF book's first pageterms_index: false # optional: no page with all terms, no Terms chapter in the book---The technical and theory handbook, exam by exam, with the school's history and a glossary.A price or a plan is not set here. You choose those in Linyup, in the course’s settings.
terms_index: false turns off the page with all terms and the book’s Terms chapter, for a course whose lessons list their terms themselves (see Terms). Leave it out to keep them; Page with all terms in the course’s settings is the same switch.
book_cover is the cover of the course as a PDF book: a portrait picture, ideally 1240 x 1754 pixels (the shape of an A4 page), PNG or JPEG. It fills the book’s first page on its own, and the title page follows. You can also upload it, or remove it, in the course’s settings next to the book switch.
A module: module.md
Section titled “A module: module.md”---title: White belt---Optional: a short summary of the module.A lesson
Section titled “A lesson”---title: From white to white-yellowstate: shown # shown, coming-soon or hiddenmessage: Available in November. # only with coming-soonvideo: https://www.youtube.com/watch?v=…attachments: [../files/handout.pdf]badge: ../media/belt-yellow.svg---## Exam programme
The lesson's text…| Setting | What it does |
|---|---|
title |
The lesson’s title. Required. |
state |
shown (the default): members can read it. coming-soon: members see the title and your message, not the content. hidden: members don’t see it. |
message |
The short note a coming-soon lesson shows. |
video |
One video at the top of the lesson: a YouTube, Vimeo or other web link. A video file can’t be used. |
audio |
One audio at the top of the lesson, as a web link. A lesson has a video or an audio, not both. |
attachments |
Files members can download, as paths from the lesson’s file, in square brackets. |
badge |
A small picture beside the lesson’s title, such as a belt: in the lesson, in the course’s lesson list and in the PDF book. |
badge_dark |
Optional: the badge’s file for dark mode, for a picture with dark outlines. |
Write the lesson in Markdown:
## A section
A paragraph with **bold**, *italic* and a [link](https://example.com).
### A smaller heading
- A bullet list- with two items
1. A numbered list2. with two steps
##starts a numbered section. Members can jump between sections from Contents.- An image on its own line becomes a figure, with its description (the text in square brackets) as the caption.
- Pictures and files are written as a path from the lesson’s file, such as
img/photo.jpgor../files/handout.pdf, and travel with the course. - Pictures can be PNG, JPEG, WebP, GIF or SVG. SVG drawings stay sharp at any size, on screen and in the PDF book. They are cleaned when uploaded: anything in the file other than the drawing is removed.
Links to other lessons
Section titled “Links to other lessons”Link to another lesson of the course with the usual Markdown link to its file, written from the lesson’s file, for example [the glossary](…/01-glossary.md) where … is the folder, such as ../03-glossary/. Add # and a heading to land on that section: [the forms](…/01-glossary.md#the-forms). The heading is written in lower case, without accents, with hyphens between the words.
Members open the linked lesson in place, at that section. In the PDF book the link jumps to that page. A link to a lesson members cannot open (a hidden one) shows as plain text, and a link to a file that is not a lesson of the course stops the import and names it.
Links to terms
Section titled “Links to terms”Link to a term of the course with a usual Markdown link whose address is term: and the term’s name, as it is written in terms.md, for example term:pyung-ahn. To put the term’s explanation in the text instead, write {{term:pyung-ahn}}: it works anywhere text does, a table cell included. A term that is not in terms.md stops the import and names it. See Terms.
Text alignment
Section titled “Text alignment”A paragraph or a heading is left-aligned unless you say otherwise. To center it, align it to the right or justify it, add the alignment in braces at its end:
## The greeting {align=center}
A long paragraph that reads better justified. {align=justify}
A closing line. {align=right}The values are left, center, right and justify; left is the default, so it never needs writing. It works for paragraphs and headings, also inside a callout or a card, but not in list items or table cells. Any other value stops the import and names it. Members see the alignment in the lesson and in the PDF book.
How a picture is shown
Section titled “How a picture is shown”Right after a picture, settings in braces change how it is shown:
{size=small align=left caption=none plain}{float=right}| Setting | What it does |
|---|---|
size=small, size=medium, size=full |
How wide it is shown: small, medium, or the full width of the text. On a phone it is never wider than the screen. |
align=left, align=center, align=right |
Where it sits on its line. Centred if you leave it out. |
float=left, float=right |
Beside the paragraphs that follow it, small unless you give a size. On a phone it goes above them. |
caption=none |
No caption under the picture. The description is still read out to people using a screen reader. |
plain |
No frame, background or rounded corners: for a symbol on a transparent background. Photos keep their frame. |
dark=../media/green-dark.svg |
Another file for dark mode, for a drawing with dark lines. Without one, a plain picture gets a light background in dark mode so its lines stay visible. |
Without braces, a picture looks as it always has. A picture in a heading (a card’s title, such as ### {plain} Programme) stays in the heading’s line, and one in a table cell stays in the cell.
- Tables, quotes and code are written the usual Markdown way.
Blocks
Section titled “Blocks”Each of the editor’s blocks has a form in the text.
Callout
Section titled “Callout”A quote whose first line is a kind in square brackets: [!note], [!tip] or [!warning].
> [!tip]> Breathe out on the strike.[!info] is read as a note, [!important] as a tip and [!caution] as a warning, so a file written for GitHub or Obsidian works as it is. A quote without a kind stays an ordinary quote.
Anything between :::card and :::. A heading at the top becomes the card’s title.
:::card### Kicks- Front kick- Side kick:::Columns side by side, between :::grid and :::. Each ::: col line starts the next column. To make a column look like a card, put a card in it.
:::grid:::card### Kicks- Front kick:::::: col:::card### Punches- Middle punch::::::The grid has as many columns as you write, two or three. To choose yourself, write :::grid{cols=2} or :::grid{cols=3}. On a phone the columns are shown one under another.
Blocks can sit inside each other, as the cards inside the grid above. Each ::: closes the block opened last.
Timeline
Section titled “Timeline”Steps in order down a vertical line, between :::timeline and :::. Each ::: step line starts the next step. Write a short label after it to mark the step with it (::: step 1, ::: step Part A); without one, the step is marked with a dot.
To mark a step with an icon instead, name it in braces: ::: step{icon=dumbbell}. You can add a label after it too (::: step{icon=footprints} Kicks). The names are those of the Lucide icons, such as dumbbell, hand, swords or trophy. A name that does not exist shows the label, or a dot, instead.
A step can also be marked with a picture of your own, such as a belt: give its path instead of a name, ::: step{icon=…/belt-green.svg}, the path written from the lesson’s file like any picture. Add dark= with a second file for dark mode if the drawing has dark lines. SVG, PNG, JPEG and WebP work; an SVG is cleaned when it is uploaded.
:::timeline::: step 1:::card### GreetingThe exam starts with the greeting.:::::: step 2:::card### Warm-up- 3 push-ups:::::: step{icon=swords} SparringLight sparring to finish.:::Show/hide answers
Section titled “Show/hide answers”A button that hides or shows the answers of every question in the lesson at once. It helps with studying: hide the answers, try to recall each one, then open the question or show them all again to check. Put it on a line of its own, wherever the button should appear, usually just before the questions:
:::answers-toggleAnswers start shown, and each question can still be opened on its own while they are hidden. In a lesson without questions the button does not appear, and the PDF book leaves it out and prints the answers.
Question
Section titled “Question”Between :::question and :::: the first heading is the question, and everything after it is the answer.
:::question### What does the name mean?"The way that teaches to protect life.":::The course’s terms go in terms.md, next to course.md. Each ## heading is a term; the explanation follows it, in the same format as a lesson:
## Pyung Ahn> 평안groups: forms, basics
The first **form** of the white belt.
## Ap Chagi {#front-kick}groups: kicks
A kick to the front, with the ball of the foot.- The term’s name for links is its heading, in lower case, without accents, with hyphens between the words:
pyung-ahn. To choose another, put it in braces after the heading:{#front-kick}. - A line starting with
>right under the heading is another spelling, shown beside the term. - A
groups:line sorts the term into groups, separated by commas. - Translations go in
terms.de.md,terms.fr.mdand so on, with the same headings. A heading that is not interms.mdstops the import.
Terms list
Section titled “Terms list”A list of terms with their explanations:
:::terms{group=forms sort=appearance}| Option | What it does |
|---|---|
group=forms |
Only the terms in that group. |
scope=lesson |
Only the terms linked in this lesson, in the order they appear here. |
sort=az |
A to Z. This is the order without sort, except with scope=lesson. |
sort=appearance |
In the order the course first links each term, module by module and lesson by lesson. Terms never linked come last, A to Z. |
new |
With scope=lesson: only the terms the course links here for the first time. |
layout=table |
A table of two columns: the term, with its other spelling under it, and its explanation. On a phone each term becomes a small box. layout=list (the default) is a list. |
Options can be combined, for example :::terms{scope=lesson new group=kicks} ends a lesson with the kicks it introduces. A group no term is in, a layout other than list or table, or an option that isn’t one of these, stops the import and names it. :::terms alone lists every term from A to Z.
Shown as written
Section titled “Shown as written”A lesson that uses any block is shown exactly as written. A lesson without any block is shaped automatically, the way older lessons are (see What members see). In such a lesson, a ### heading that ends in “?” is also read as a question, followed by its answer:
### What does the name mean?
"The way that teaches to protect life."Not supported
Section titled “Not supported”- A price or a plan (set them in Linyup).
- Video files: a video is always a link, and one per lesson, at the top.
- HTML in the text: it is cleaned out. Use the blocks instead.
- Accordions, tabs, footnotes and formulas.