dockview/packages/docs
2024-12-22 19:20:36 +00:00
..
blog chore: v2.1.4 docs 2024-12-22 19:19:38 +00:00
docs Merge pull request #743 from mathuo/689-docs-demos-for-vanilla-js-support 2024-11-15 20:48:58 +00:00
jsexamples chore: move docs package 2022-05-26 21:54:35 +01:00
old_docs_DELETE_SOON feat: multiple framework support work 2024-04-15 21:18:21 +01:00
sandboxes chore: docs 2024-12-22 19:20:24 +00:00
scripts chore: docs 2024-06-08 21:39:43 +01:00
src chore: docs 2024-12-22 09:41:57 +00:00
static chore: docs 2024-12-22 09:41:57 +00:00
templates/dockview chore: docs 2024-10-29 20:22:40 +00:00
web-server Block malicious looking requests to prevent path traversal attacks. 2024-11-07 17:23:01 +01:00
.gitignore feat: multiple framework support work 2024-03-27 21:32:05 +00:00
babel.config.js chore: move docs package 2022-05-26 21:54:35 +01:00
docusaurus.config.js chore: improve docs 2024-07-09 21:16:59 +01:00
locate.js 475 improved docs (#484) 2024-02-25 12:32:58 +00:00
package.json chore(release): publish v2.1.4 2024-12-22 19:20:36 +00:00
README.md chore: move docs package 2022-05-26 21:54:35 +01:00
sidebars.js chore: fix docs 2024-02-25 15:25:21 +00:00
tsconfig.json chore: auto-gen type docs 2023-10-01 21:55:15 +01:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn 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

$ yarn 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 yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn 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.