build-workflow.md

Build Script for Developers

From v1.1, a build script is provided for your convenience. It will follow the naming convention, and requires bash and mustache.js to run.

When you run at the first time:

# Check if mustache.js is able to run in current bash
mustache -v

# Check if the script works
source build.sh --help

Build workflow:

1. Build a new color scheme: source build.sh [new-name] (no space, e.g. awesome-dark)

2. The script will create a new json file in a new folder:

   

3. In the json file:

   • Change the name according to the theme, e.g. "Awesome Dark"
   • This name will be parsed into definition name in 2 XML files:
     • "Markdown (Awesome Dark)" for modern build
     • "Markdown [Awesome Dark]" for classic build
   • Add your prefered colors in the empty strings, e.g. "FFFFFF"

   

4. Build XML files using the same command: source build.sh [new-name]

   tips: Press ⬆️ to show your previous command.

5. It builds 2 XML files in root directory of this repo.

   

6. Import the XML files in Notepad++ for testing. It's cool, right?

   tips: Since the old XML is not overwritten, you can import and compare two files in NPP.

7. Move the XML files into the corresponding theme folder. Done!