Home Explore Help
Sign In
cturan
/
vendure
mirror of https://github.com/vendure-ecommerce/vendure
1
0
Fork 0
Files Issues 0 Wiki
Tree: 517bd109cb
Branches Tags
vendure
/
docs
Michael Bromley 517bd109cb chore: Get docs building in docusaurus 2 years ago
..
archetypes 3aceae8298 chore(docs): Move Hugo site back into docs 2 years ago
assets 7866dbf05d docs: Updates to docs with new APIs etc 2 years ago
content 2070068960 chore: Set up docusaurus and move content 2 years ago
data 3eca335871 docs: Update docs 2 years ago
diagrams 28324c7657 feat(docs): Group core plugin docs 2 years ago
docs 517bd109cb chore: Get docs building in docusaurus 2 years ago
layouts d362b41c25 chore: Update docs structure 2 years ago
src 517bd109cb chore: Get docs building in docusaurus 2 years ago
static 517bd109cb chore: Get docs building in docusaurus 2 years ago
.gitignore 517bd109cb chore: Get docs building in docusaurus 2 years ago
README.md 517bd109cb chore: Get docs building in docusaurus 2 years ago
babel.config.js 517bd109cb chore: Get docs building in docusaurus 2 years ago
config.toml f1d62add13 fix(docs): Fix docs base URL 2 years ago
docusaurus.config.js 517bd109cb chore: Get docs building in docusaurus 2 years ago
netlify.toml 3aceae8298 chore(docs): Move Hugo site back into docs 2 years ago
package.json 517bd109cb chore: Get docs building in docusaurus 2 years ago
postcss.config.js 3aceae8298 chore(docs): Move Hugo site back into docs 2 years ago
sidebars.js 517bd109cb chore: Get docs building in docusaurus 2 years ago
tailwind.config.js 3aceae8298 chore(docs): Move Hugo site back into docs 2 years ago
tsconfig.json 517bd109cb chore: Get docs building in docusaurus 2 years ago
webpack.config.ts 3aceae8298 chore(docs): Move Hugo site back into docs 2 years ago
yarn.lock 517bd109cb chore: Get docs building in docusaurus 2 years ago

README.md

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.