This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.

History

Jens L 677bcaadd7 core: add initial app launch url (#2367 ) Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>		2022-02-23 22:48:55 +01:00
..
developer-docs	core: add initial app launch url (#2367 )	2022-02-23 22:48:55 +01:00
docs	core: add initial app launch url (#2367 )	2022-02-23 22:48:55 +01:00
help	root: fix linting errors	2021-07-18 20:54:34 +02:00
integrations	website/integrations: add Paperless-ng instructions (#2225 )	2022-02-10 09:45:22 +01:00
netlify/functions	website: remove .git suffix for go import	2021-10-18 17:48:13 +02:00
src	website: remove remaining /index URLs	2021-12-13 19:01:16 +01:00
static	website: remove static service account, use helm chart instead	2021-11-03 00:14:01 +01:00
.gitignore	root: build bundled docs into helo dir to fix path issue with packaged static files	2021-07-13 19:09:16 +02:00
.prettierignore	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
.prettierrc.json	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
README.md	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
babel.config.js	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
docusaurus.config.js	website/docs: add proxy custom header docs	2021-11-30 11:12:34 +01:00
docusaurus.docs-only.js	website: fix build for docs-only target	2021-11-22 12:11:24 +01:00
netlify.toml	website: add initial redirect (#1918 )	2021-12-13 20:42:31 +00:00
package-lock.json	build(deps): bump rapidoc from 9.1.4 to 9.1.8 in /website (#2348 )	2022-02-21 09:39:45 +01:00
package.json	build(deps): bump rapidoc from 9.1.4 to 9.1.8 in /website (#2348 )	2022-02-21 09:39:45 +01:00
sidebars.js	website/docs: add 2022.2 release notes	2022-02-16 10:27:25 +01:00
sidebarsDev.js	website/docs: add rough documentation style guide	2022-01-29 23:52:03 +01:00
sidebarsIntegrations.js	website/integrations: add Paperless-ng instructions (#2225 )	2022-02-10 09:45:22 +01:00

README.md

Website

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

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open 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

GIT_USER=<Your GitHub username> USE_SSH=true 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.