3pp-mirror/neko
1
0
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2025-04-28 18:06:20 +02:00
Code Issues Projects Releases Packages Wiki Activity
neko/webpage
History
Miroslav Šedivý 409a5f1426 update docs.
2025-03-30 20:20:30 +02:00
..
docs update docs. 2025-03-30 20:20:30 +02:00
src update docs with more deeplinking. 2025-03-26 22:46:11 +01:00
static move CNAME to satic. 2025-02-23 12:00:25 +01:00
versioned_docs/version-v2 update docs and add examples + ungoogled chromium svg. 2025-02-16 23:43:53 +01:00
versioned_sidebars add v2 docs. 2025-02-08 15:04:31 +01:00
.gitignore WIP add docusaurus webpage. 2025-02-01 19:10:47 +01:00
docusaurus.config.ts update docs. 2025-03-22 18:53:45 +01:00
gen-api-docs.sh change API index page. 2025-03-22 17:52:56 +01:00
package-lock.json fix website. 2025-02-23 11:52:53 +01:00
package.json fix links on webpage. 2025-03-22 23:02:57 +01:00
README.md WIP add docusaurus webpage. 2025-02-01 19:10:47 +01:00
sidebars.ts fix links on webpage. 2025-03-22 23:02:57 +01:00
tsconfig.json WIP add docusaurus webpage. 2025-02-01 19:10:47 +01:00
versions.json add v2 docs. 2025-02-08 15:04:31 +01:00

README.md

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.