mirror of
https://github.com/orhun/git-cliff.git
synced 2024-12-16 11:43:35 +03:00
5dc5fb786d
BREAKING: `CommitPreprocessor` is renamed as `TextProcessor` * feat: add postprocessors to changelog This will enable things like replacing usernames with github usernames #132 * review comments * refactor(clippy): apply clippy suggestions * refactor(postprocessors): polish the implementation * docs(postprocessors): update documentation about GitHub usernames * style(format): update formatting --------- Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com> |
||
---|---|---|
.. | ||
blog | ||
docs | ||
src | ||
static | ||
.gitignore | ||
babel.config.js | ||
docusaurus.config.js | ||
package-lock.json | ||
package.json | ||
README.md | ||
sidebars.js | ||
tsconfig.json | ||
yarn.lock |
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.