Skip to content

Commit 5448221

Browse files
Fix readme build (#1459)
1 parent a33ba15 commit 5448221

11 files changed

+163492
-3668
lines changed

.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
- name: Install node modules
6565
run: yarn install
6666
- name: Verify README.md
67-
run: yarn unibuild readme && git diff --quiet README.md
67+
run: yarn readme && git diff README.md
6868
verify-install:
6969
runs-on: ubuntu-latest
7070
strategy:

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ src/normalize_mappings/suffix-normalize-mapping.ts
1010
src/parser/chord/combined_grammer.pegjs
1111
src/parser/chord/suffix_grammar.pegjs
1212
src/parser/chord_pro/sections_grammar.pegjs
13+
tmp

.husky/pre-commit

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/bin/sh
22
. "$(dirname "$0")/_/husky.sh"
33

4-
yarn unibuild build readme
4+
yarn readme
55
git add README.md

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ I love receiving pull requests from everyone! Please read this short document be
77
### `README.md`
88

99
Are you trying to make changes to `README.md`? Wait! `README.md` is a auto-generated file.
10-
- to make changes in the first part, go to [docs/README.hbs](docs/README.hbs)
10+
- to make changes in the first part, go to [INTRO.md](INTRO.md)
1111
- the api docs are generated from JSdoc comment embedded in the code, so changing those
1212
comments will result in API doc changes.
1313

14-
When your changes are complete, be sure to run `yarn readme` to regenerate `README.md` and commit the updated `README.md` _together_ with the `README.hbs` changes and/or API doc changes.
14+
When your changes are complete, be sure to run `yarn readme` to regenerate `README.md` and commit the updated `README.md` _together_ with the `INTRO.md` changes and/or API doc changes.
1515

1616
## Pull request guidelines
1717

doc/README.hbs INTRO.md

-2
Original file line numberDiff line numberDiff line change
@@ -360,5 +360,3 @@ use those to change the generated output.
360360

361361
Note: all classes, methods and constants that are documented here can be considered public API and will only be
362362
subject to breaking changes between major versions.
363-
364-
{{>main}}

0 commit comments

Comments
 (0)