You'll need to install the dependencies, to do that install node and use this command. You only need to do this once.
cd is-your-waifu-legal
npm install
then run the shell script to generate the site. You'll need to do this for every change you make.
bash ./generate-site.sh
change the current directory to the output and run jekyll. I also recommend opening a new console window/tab for doing this, so that jekyll can watch for changes from the generate-site script and automatically generate the site for you.
cd output-site
jekyll s
Jekyll will output a server address, open your browser and use that address as a link to open the site on your browser.
# Look out for this line from jekyll #
Server address: http://127.0.0.1:4000
To stop jekyll, press ctrl + c.
| Variable | Type | Flags | Description |
|---|---|---|---|
type |
number | required | unused, for future use. Keep at 0 for now. |
english-name |
string | optional | |
japanese-name |
string | optional | |
aliases |
array of strings | optional | other names the waifu is known as. |
image |
string | optional | a link to a picture of the waifu |
notes |
array of strings | optional | each element in the array is one bullet point or one point |
sources |
array of strings | required | each element in the array is one link to where this info came from. It can be a video or an article or book or etc. |
definitely-legal |
boolean | optional | true if notes or other info states she's legal |
is-a-trap |
boolean | optional | unused |
if not legal based on birthday, then there will be a countdown displayed for when they become legal.
| Variable | Type | Flags | Description |
|---|---|---|---|
month |
number | optional | |
day-of-month |
number | optional | |
year |
number | optional |
| Variable | Type | Flags | Description |
|---|---|---|---|
age-group-by-appearance |
string | optional | can be child or teenager or adult |
age-range-by-appearance |
array of 2 numbers | optional | the first number is the start of the range and the 2nd is the end of the range. For example, ages 1 to 10 is [1, 10] |
| Variable | Type | Flags | Description |
|---|---|---|---|
age-in-show |
number | optional | the age of the waifu during the story |
finally-legal-in-show |
string | optional | the episode, movie, volume, etc. when they became of legal age |