Windows Setup

Node.js and Hexo

• Download Node.js. Allow the installer to add Node to your PATH.
• Open cmd.exe and type in: npm install hexo-cli -g
• Now cd into the rainmeter-docs directory
• Remove the node_modules directory
• Run npm install

Repeat these steps to update Node.js/Hexo. Repeat the last two steps whenever package.json changes.

Git

Install Git for Windows. Then, in Git Bash (C:\Program Files\Git\git-bash.exe), type in the following (with your details, of course):

git config --global user.email "[email protected]"
git config --global user.name "Your Name"

SSH key (for deplyoing)

Note that this only needs to be done once. If %HOMEPATH%\ssh\id_rsa.pub already exists and has been added to GitHub, you can skip this step.

• Open Git Bash and type in ssh-keygen -t rsa -b 2048
• Add the new SSH key to GitHub. Copy the contents of %HOMEPATH%\ssh\id_rsa.pub as the key.

Building Site

You can build the site using hexo generate or preview it using hexo server.

If this is all you need, stop here. Otherwise read on.

Deploying Site

When you make changes to the site, commit them to the master branch.

When you are ready to deploy your changes to docs.rainmeter.net, run deploy.sh. This will generate the site and commit them to the gh-pages branch.