Archived

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

Stratos Gerakakis 5f4812e1d0 website/docs: fix Minor typo (#3196 ) Signed-off-by: Stratos Gerakakis <stratos@gerakakis.net>		2022-07-02 19:48:53 +02:00
..
developer-docs	api: add basic jwt support with required scope (#2624 )	2022-06-26 17:51:15 +02:00
docs	website/docs: add snippet to skip authenticated flow	2022-07-02 18:41:16 +02:00
help	root: fix linting errors	2021-07-18 20:54:34 +02:00
integrations	website/docs: cleanup vikunja docs	2022-06-26 18:29:17 +02:00
netlify/functions	*: cleanup vendor	2022-05-28 21:26:33 +02:00
src	website: format docs with prettier (#2833 )	2022-05-09 21:22:41 +02:00
static	core: create FlowToken instead of regular token for generated recovery links (#3193 )	2022-07-02 14:17:41 +02: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	website: format docs with prettier (#2833 )	2022-05-09 21:22:41 +02:00
.prettierrc.json	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: start troubleshooting page for forward auth	2022-06-21 22:26:17 +02:00
docusaurus.docs-only.js	migrate to main (#3035 )	2022-06-03 19:40:09 +02:00
netlify.toml	website: add initial redirect (#1918 )	2021-12-13 20:42:31 +00:00
package-lock.json	build(deps-dev): bump prettier from 2.7.0 to 2.7.1 in /website (#3107 )	2022-06-17 09:38:57 +02:00
package.json	build(deps-dev): bump prettier from 2.7.0 to 2.7.1 in /website (#3107 )	2022-06-17 09:38:57 +02:00
README.md	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
sidebars.js	flows: add shortcut to redirect current flow (#3192 )	2022-07-01 23:19:41 +02:00
sidebarsDev.js	website/docs: add rough documentation style guide	2022-01-29 23:52:03 +01:00
sidebarsIntegrations.js	website/docs: fix Minor typo (#3196 )	2022-07-02 19:48:53 +02: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.