mirror of https://github.com/m1k1o/neko.git synced 2026-11-03 00:11:48 -06:00

Files

T

Miroslav Šedivý f399ac8df5 chore: update dependencies and devDependencies to latest versions

- Upgraded @docusaurus/core and @docusaurus/preset-classic from 3.7.0 to 3.10.2
- Upgraded docusaurus-plugin-openapi-docs and docusaurus-theme-openapi-docs from 4.3.4 to 5.2.0
- Upgraded @docusaurus/module-type-aliases, @docusaurus/tsconfig, and @docusaurus/types from 3.7.0 to 3.10.2
- Added overrides for js-yaml, postcss-selector-parser, serialize-javascript, tinypool, uuid, and yaml

2026-10-20 10:29:04 +02:00

docs

docs: fix Apache websocket rewrite for /api/ws (#717 )

2026-10-16 21:43:34 +02:00

scripts

update config options naming, move scripts to own folder.

2025-04-05 18:24:23 +02:00

src

docs: update developer guide with build instructions and add local development setup. (#661 )

2026-07-30 17:08:21 +02:00

static

add SECURITY.md file.

2025-04-21 16:03:51 +02:00

versioned_docs/version-v2

docs: fix typo acheived -> achieved (#696 )

2026-08-29 13:46:13 +02: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

chore: update dependencies and devDependencies to latest versions

2026-10-20 10:29:04 +02:00

package-lock.json

chore: update dependencies and devDependencies to latest versions

2026-10-20 10:29:04 +02:00

package.json

chore: update dependencies and devDependencies to latest versions

2026-10-20 10:29:04 +02:00

README.md

WIP add docusaurus webpage.

2025-02-01 19:10:47 +01:00

sidebars.ts

docs: update developer guide with build instructions and add local development setup. (#661 )

2026-07-30 17:08:21 +02: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.