diff --git a/README.md b/README.md index dc28789..652f447 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ # Northwich committee of magic researches songs repository -Just a collection of lyrics of songs. Probably will be managed into proper folders. Probably will have LRCs. \ No newline at end of file + +Just a collection of lyrics of songs. Probably will be managed into proper folders. Probably will have LRCs. + +## Publishing to the wiki + +Song pages are auto-published to by the +**songs pipeline** in the companion repo `novoyuuparosk-auto-wiki` (the +"repo next door"). It triggers on push to `master`. + +- **Source-file contract** (frontmatter fields, body conventions): see + [`pipelines/songs/SCHEMA.md`](../novoyuuparosk-auto-wiki/pipelines/songs/SCHEMA.md) + in `novoyuuparosk-auto-wiki`. +- **Pipeline overview** (branch convention, triggers, categories, LRC, etc.): + [`pipelines/songs/README.md`](../novoyuuparosk-auto-wiki/pipelines/songs/README.md). + +In short: a file is published when its frontmatter has `wiki.publish: true` +and it isn't under `wip/`. The `title` field becomes the wiki page name. + +## Side-by-side lyrics (columns shorthand) + +To lay two (or more) versions of a song next to each other — e.g. an original +and its translation — use a fenced code block tagged `columns`, with each +column separated by a line containing only `===`: + +````markdown +```columns +**原題** + +一行目 +二行目 +=== +**Title** + +first line +second line +``` +```` + +Notes: + +- Line breaks and blank lines are preserved verbatim (each column is rendered + with line breaks intact). +- `N` columns ⇒ `N − 1` `===` separators. +- Use Markdown emphasis inside the block: `*italic*`, `**bold**`, + `***bold-italic***`. (No need for raw HTML.) + +This is implemented entirely by the auto-wiki pipeline at publish time; the +authoritative description lives in +[`SCHEMA.md`](../novoyuuparosk-auto-wiki/pipelines/songs/SCHEMA.md#columns-side-by-side-shorthand). +See [`kairo/kimito_en.md`](kairo/kimito_en.md) for a real example.