{"id":13524919,"url":"https://github.com/ljgago/typst-chords","last_synced_at":"2026-05-03T22:04:34.399Z","repository":{"id":167042618,"uuid":"641686717","full_name":"ljgago/typst-chords","owner":"ljgago","description":"A package to write song lyrics with chord diagrams in Typst","archived":false,"fork":false,"pushed_at":"2025-11-18T00:29:09.000Z","size":1912,"stargazers_count":64,"open_issues_count":1,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-21T00:02:37.260Z","etag":null,"topics":["chords","guitar","piano","typst"],"latest_commit_sha":null,"homepage":"","language":"Typst","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ljgago.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-05-17T00:50:09.000Z","updated_at":"2026-03-23T02:10:04.000Z","dependencies_parsed_at":"2024-01-13T22:25:07.567Z","dependency_job_id":"2ef5263c-6cb7-4b8e-99a0-34358b3d2d56","html_url":"https://github.com/ljgago/typst-chords","commit_stats":null,"previous_names":["ljgago/typst-chords"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/ljgago/typst-chords","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ljgago%2Ftypst-chords","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ljgago%2Ftypst-chords/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ljgago%2Ftypst-chords/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ljgago%2Ftypst-chords/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ljgago","download_url":"https://codeload.github.com/ljgago/typst-chords/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ljgago%2Ftypst-chords/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32586189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chords","guitar","piano","typst"],"created_at":"2024-08-01T06:01:14.593Z","updated_at":"2026-05-03T22:04:34.387Z","avatar_url":"https://github.com/ljgago.png","language":"Typst","funding_links":[],"categories":["Templates \u0026 Libraries","Typst"],"sub_categories":["Music"],"readme":"# chordx\n\nA package to write song lyrics with chord diagrams in Typst.\n\n**Table of Contents**\n\n- [Introduction](#introduction)\n- [Usage](#usage)\n  - [Typst Packages](#typst-packages)\n  - [Local Packages](#local-packages)\n- [Documentation](#documentation)\n- [Examples](#examples)\n  - [Chart Chords](#chart-chords)\n  - [Piano Chords](#piano-chords)\n  - [Single Chords](#single-chords)\n- [Changelog](#changelog)\n- [License](#license)\n\n## Introduction\n\nWith `chordx` you can easily generate song lyrics with chords for writing songbooks.\n\n`chordx` generates chord charts for stringed instruments (e.g. guitar, ukulele, etc.), piano chords (with diferent piano layouts) and single chords that are chords without charts used to write the chords over a word to write songbooks.\n\n## Usage\n\n`chordx` exports 3 functions to generate diferents types fo charts:\n\n- `chart-chord`: used to generate chart chords for stringed instruments.\n- `piano-chord`: used to generate piano chords.\n- `single-chord`: used to show the chord name over a word.\n\n### Typst Packages\n\nTypst added an experimental package repository and you can import `chordx` as follows:\n\n```typ\n#import \"@preview/chordx:0.7.0\": *\n```\n\n### Local Packages\n\nIf the package hasn't been released yet, or if you just want to use it from this repository, you can use _*local-packages*_.\n\nYou can read the documentation about typst [local-packages](https://github.com/typst/packages#local-packages) and learn about the path folders used in differents operating systems (Linux / MacOS / Windows).\n\nIn Linux you can do:\n\n```sh\ngit clone https://github.com/ljgago/typst-chords ~/.local/share/typst/packages/local/chordx/0.7.0\n```\n\nAnd import the package in your file:\n\n```typ\n#import \"@local/chordx:0.7.0\": *\n```\n\n## Documentation\n\nHere [chordx-docs](docs/chordx-docs.pdf) you have the reference documentation that describes the functions and parameters used in this package. (_Generated with [tidy](https://github.com/Mc-Zen/tidy)_)\n\n## Examples:\n\n### Chart Chords\n\n```typ\n#import \"@preview/chordx:0.7.0\": chart-chord\n\n#let chart-chord-sharp = chart-chord.with(size: 18pt)\n#let chart-chord-round = chart-chord.with(size: 1.5em, design: \"round\")\n\n// Design \"sharp\"\n#chart-chord-sharp(tabs: \"x32o1o\", fingers: \"n32n1n\")[C]\n#chart-chord-sharp(tabs: \"ooo3\", fingers: \"ooo3\")[C]\n\n// Desigh \"round\" with position \"bottom\"\n#chart-chord-round(tabs: \"xn332n\", fingers: \"o13421\", fret: 3, capos: \"115\", position: \"bottom\")[Cm]\n#chart-chord-round(tabs: \"onnn\", fingers: \"n111\", capos: \"313\", position: \"bottom\")[Cm]\n\n// Design \"round\" with background color in chord name\n#chart-chord-round(tabs: \"xn332n\", fingers: \"o13421\", fret: 3, capos: \"115\", background: silver)[Cm]\n#chart-chord-round(tabs: \"onnn\", fingers: \"n111\", capos: \"313\", background: silver)[Cm]\n```\n\n\u003ch3 align=\"center\"\u003e\n  \u003ca href=\"examples/chart-chords.typ\"\u003e\n    \u003cimg\n      alt=\"Chart Chord\"\n      src=\"examples/chart-chords.svg\"\n      style=\"max-width: 100%; width: 100%;\"\n    \u003e\n  \u003c/a\u003e\n\u003c/h3\u003e\n\n### Piano Chords\n\n```typ\n#import \"@preview/chordx:0.7.0\": piano-chord\n\n#let piano-chord-sharp = piano-chord.with(layout: \"F\", size: 18pt)\n#let piano-chord-round = piano-chord.with(layout: \"F\", size: 1.5em, design: \"round\")\n\n#piano-chord-sharp(keys: \"B1, D2#, F2#\", fill-key: blue)[B]\n#piano-chord-round(keys: \"B1, D2#, F2#\", fill-key: yellow, position: \"bottom\")[B]\n#piano-chord-round(keys: \"B1, D2#, F2#\", fill-key: red)[B]\n```\n\n\u003ch3 align=\"center\"\u003e\n  \u003ca href=\"examples/piano-chords.typ\"\u003e\n    \u003cimg\n      alt=\"Piano Chord\"\n      src=\"examples/piano-chords.svg\"\n      style=\"max-width: 100%; width: 100%;\"\n    \u003e\n  \u003c/a\u003e\n\u003c/h3\u003e\n\n### Single Chords\n\n```typ\n#import \"@preview/chordx:0.7.0\": single-chord\n\n#let chord = single-chord.with(\n  font: \"PT Sans\",\n  size: 12pt,\n  inner-gap: 0.2em,\n  outer-gap: 0.6em,\n  weight: \"semibold\",\n  background: silver\n)\n\n#chord[Jingle][G][2] bells, jingle bells, jingle #chord[all][C][2] the #chord[way!][G][2] \\\n#chord[Oh][C][] what fun it #chord[is][G][] to ride \\\nIn a #chord[one-horse][A7][2] open #chord[sleigh,][D7][3] hey!\n```\n\n\u003ch2 align=\"center\"\u003e\n  \u003ca href=\"examples/single-chords.typ\"\u003e\n    \u003cimg\n      alt=\"Single Chord\"\n      src=\"examples/single-chords.svg\"\n      style=\"max-width: 100%; width: 450pt;\"\n    \u003e\n  \u003c/a\u003e\n\u003c/h2\u003e\n\n## Changelog\n\nYou can read the latest changes in [CHANGELOG.md](./CHANGELOG.md)\n\n## License\n[MIT License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fljgago%2Ftypst-chords","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fljgago%2Ftypst-chords","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fljgago%2Ftypst-chords/lists"}