Eskmo Documentation

Installation

First, install Node.js from nodejs.org.

Once installed, you can set up npx globally by running:

npm install -g npx

Then:

npm install

Developing

To start the local build server with hot module reloading and an eslint watcher, execute:

npx vitepress dev

Building

To compile the entire site into a static project, use the following command:

npx vitepress build

Previewing

To preview the built site locally, run:

npx vitepress preview

If you want to verify the build without using VitePress, navigate to the dist directory and start a local server:

cd .vitepress/dist; python -m http.server

Deploy

If you haven't installed gh-pages yet, run the following command:

npm install --save-dev gh-pages

Push the built files to the `gh-pages branch:

npm run deploy