mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-28 18:06:20 +02:00
.. | ||
docs | ||
src | ||
static | ||
versioned_docs/version-v2 | ||
versioned_sidebars | ||
.gitignore | ||
docusaurus.config.ts | ||
package-lock.json | ||
package.json | ||
README.md | ||
sidebars.ts | ||
tsconfig.json | ||
versions.json |
Website
This website is built using Docusaurus, a modern static website generator.
Installation
$ npm run install
Local Development
$ npm run start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ npm run build
This command generates static content into the build
directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true npm run deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> npm run deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages
branch.