Download HTML Help Workshop and install it.

Download the latest NodeJS version and install it.

Launch a command line tool inside the help project folder. Run:

npm i

npm start

or just

gulp

Articles are located in the ./src/articles folder

Assets, such as images, styles, javascript, etc. are located in the ./src/assets folder

Styles are compiled from .scss files. Source scss files are located in the ./src/assets/sass folder. The main scss file, that imports component styles, vendor styles, etc. is style.scss. It is compiled with gulp-sass to style.css, which is linked to in every HTML article.

JS files are not concatenated to a single file. All JS files you want to include to HTML articles must be manually added to the ./src/assets/partials/[header\footer].html - for the CHM format, or to the ./src/assets/partials/web[Header\Footer].html - for the Web help format.

The gulp (gulp default) task runs build and watch tasks. Each time you save an article HTML file or an asset file, gulp compiles HTML, SASS, JS, images, as well as runs the HTML Help Workshop compiler to compile the %projectName%.chm file. The dist folder contains Web and CHM help formats.

Highlight.js is used. Several highlighting styles are included in the ./src/assets/highlight.styles/ directory. To change the style, pick another style *.css, add _ in the beginning of its name, and put the file to the ./src/assets/sass/ folder. In the style.scss change the highlight style file name.

It is highly recommended to give the chm, hhc, hhk, hhp files the same name as the folder containing the whole project. Since some functionality in the gulpfile.js uses the project root directory name to call such files.