1
1
mirror of https://github.com/orhun/git-cliff.git synced 2024-12-15 14:51:59 +03:00
git-cliff/website
Caleb Maclennan 65d365c7b5
refactor(docker): avoid copying volume inside container (#142)
* refactor(docker): avoid copying volume inside container

* docs(readme): Fix Docker tips to mount project, not just repository

Otherwise any project configs have no chance of being read...
2023-05-18 20:45:32 +02:00
..
blog docs(blog): add blog post about what's new in 1.2.0 2023-04-28 16:09:11 +03:00
docs refactor(docker): avoid copying volume inside container (#142) 2023-05-18 20:45:32 +02:00
src refactor(website): update header location 2023-04-10 21:25:05 +03:00
static chore(website): move website to website folder 2023-04-09 18:16:31 +03:00
.gitignore chore(website): move website to website folder 2023-04-09 18:16:31 +03:00
babel.config.js chore(website): move website to website folder 2023-04-09 18:16:31 +03:00
docusaurus.config.js docs(website): add Twitter link to banner 2023-04-09 20:06:54 +03:00
package-lock.json chore(website): move website to website folder 2023-04-09 18:16:31 +03:00
package.json chore(website): move website to website folder 2023-04-09 18:16:31 +03:00
README.md chore(website): move website to website folder 2023-04-09 18:16:31 +03:00
sidebars.js chore(website): move website to website folder 2023-04-09 18:16:31 +03:00
tsconfig.json chore(website): move website to website folder 2023-04-09 18:16:31 +03:00
yarn.lock chore(website): move website to website folder 2023-04-09 18:16:31 +03: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.