n9gc/Readme i18n Switcher
Automatically generate a language switcher table in README.md based on translated README.*.md files. Without `git push`.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| folders | Folders of READMEs, one line each | no | — |
| fileName | The pattern of readme files' name, where `{lang}` is used to match the locale of the readme. RFC 6570. | no | — |
| repoReadme | The readme file that will be displayed as repo's README. If not provided, repo's README will not be changed. | no | — |
| tag | The name of the html commit tag. | no | — |
| switcherBody | Template string for the outter of switcher. micromustache. all vars: - `lines` the inner text of the switcher | no | — |
| switcherLine | Template string for each language option of switcher. micromustache. all vars: - `display` the localed language option to display - `filePath` the path of the readme - `folder` the folder of the readme - `lang` the text inside `{lang}` of the readme file | no | — |
| switcherLineActive | Template string for the language option of the readme now. micromustache. all vars: - `display` the localed language option to display - `filePath` the path of the readme - `folder` the folder of the readme - `lang` the text inside `{lang}` of the readme file | no | — |
| switcherSpliter | Text used to separate each language option of the switcher | no | — |
Outputs
no outputs