ghost-theme-locales
v0.0.3
Published
CLI tool to create locale json files in Ghost themes
Downloads
191
Maintainers
Readme
Ghost Theme Locales (gtl)
CLI tool to create locale json files in Ghost themes.
Table of Contents
Installation
Ensure you have Node.js installed. Then, install GTL globally using npm:
npm install -g ghost-theme-locales
or install locally in your project:
npm install -D ghost-theme-locales
Preparation
Before using this tool prepare your theme files. Use {{t}}
in your .hbs
files to make the hard coded strings translatable. Know more about {{t}}
helper here at Ghost official documentation.
After preparing your theme you can use this tool to generate your language file.
Usage
gtl <command> [options]
Commands
gtl
gtl [option]
| Option | Description |
| ----------------- | :----------------------------------------------------------- |
| --version
| Output the version number |
| --help
| Output usage information |
gtl create
gtl c [options]
or
gtl create [options]
| Option | Description | Default |
| ----------------- | :----------------------------------------------------------- | :------ |
| -l
, --language
| Language code | en
|
| -f
, --forceRewrite
| Force rewrite existing locales file even if it has no new strings | false
|
Developer Setup
- Fork this repo
git clone https://github.com/<your-username>/ghost-theme-locales.git path/to/your/workspace
cd path/to/your/workspace
npm install
To run the CLI using your workspace files
npm link
gtl <command> [options]
( you can run anywhere on your system)
Copyright & License
- MIT License
- Copyright (c) 2024 Priority Vision.
- Original idea from https://github.com/biswajit-saha/ghost-theme-translator
- Ghost is a trademark of Ghost Foundation Ltd.