Michael Bromley bcc3335e71 Merge branch 'master' into minor 7 months ago
..
content 63e7e443bd Merge branch 'minor' into new-docs 2 years ago
docs bcc3335e71 Merge branch 'master' into minor 7 months ago
layouts 63e7e443bd Merge branch 'minor' into new-docs 2 years ago
scraper 3322a5633e docs: Fix scraper config 2 years ago
src 03cc86764b docs: Use GraphiQL in the Vendure docs (#3543) 8 months ago
static 07e74f7daa docs: Update logo in docs site 1 year ago
.gitignore 2645afb855 docs: Add complete plugin tutorial 2 years ago
README.md e5f0d48913 chore(docs): Update readme docusaurus version 1 year ago
babel.config.js 517bd109cb chore: Get docs building in docusaurus 2 years ago
docusaurus.config.js 4794d12c9e feat(docs): Add llmTxtPlugin to generate concatenated MDX content and documentation index for LLMs 8 months ago
package-lock.json d64fa78689 fix(docs): Docusaurus build 9 months ago
package.json d64fa78689 fix(docs): Docusaurus build 9 months ago
sidebars.js 6eb7071cfb docs: Add guide to new Dashboard 8 months ago
tsconfig.json 517bd109cb chore: Get docs building in docusaurus 2 years ago

README.md

Website

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

Installation

$ npm run

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.