Repository navigation
Admin Tips
github-actions[bot] edited this page Feb 20, 2026
·
6 revisions
Practical tips for using the in‑app Admin editor (/admin) to author and update songs.
- Load existing or start a new song. Use Quick chords and Directives to speed up editing.
- Click Check to catch common ChordPro issues.
- Stage to convert (when needed) and queue the song.
- Publish to open a PR with staged files, or Download to export a ZIP for manual copy.
- Saves as .chordpro: Files are always saved with a
.chordproextension. - Edits Author: Required before Publish; appended to the PR body.
- Quick chords: Click buttons or use hotkeys to insert
[Chord]at the caret:- Win/Linux: Alt+1..6
- macOS: Ctrl+1..6
- Standard fields map to ChordPro directives:
{title: ...},{key: ...},{tags: ...},{authors: ...},{country: ...},{youtube: ...},{mp3: ...}. - Translation fields:
-
{song_id: ...}links language variants into one translation group. -
{lang: ...}marks language (en,tr,ar,es). If missing, the app assumes English.
-
- Translation titles can differ from English titles as long as
song_idmatches. - Metadata inheritance applies at index build time: non-English variants inherit English
key/tags/authors/country/youtube/mp3/pptxunless they set non-empty overrides. - Filenames derive from the title id (underscore slug), but are editable in the staging table.
- PPTX files link automatically by slug:
public/pptx/<song-filename-without-ext>.pptx. - No PPTX field is needed in the editor.
- Live preview parses ChordPro (including
{start_of_*}/{end_of_*}) and shows section labels with chords aligned.
npm run normalize # fix names; prefer underscores
npm run build-index # update src/data/index.json
npm run test:mvp # PDF layout guards
npm run build # output to docs/- Importing-Lyrics — convert DOCX/PDF/TXT to a ChordPro skeleton (directives by default).
-
User Guide
-
Editing & Admin
-
Developer Guide
-
Infrastructure
-
Mobile