This VitePress site is hosted from GitHub.io pages at justme.dev.

Requirements

Node version manager

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion

nvm install
nvm use

Python & pip

sudo apt install python3 python3-pip
python3 -m pip install --upgrade pip
pip install -r requirements.txt

Install dependencies

npm install

How to use

Generate content

Downloads readme files from GitHub repositories.

npm run docs:generate

Development

npm run docs:dev

Build

npm run docs:build

Preview build

npm run docs:preview

Deploy

Commit to the main branch to trigger deployment.

Notes

• Create request files in the requests folder.
• Run the npm run docs:generate command to generate the markdown files locally.
• When pushing to main GitHub action does generate, build and deploy.
• The generated markdown will be saved in a sub folder defined by request type using the same name as the request file and the suffix .md.