From 76f62c5381f35c9f8d5dc3b1888e22e9e3294472 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Orhun=20Parmaks=C4=B1z?= Date: Sun, 9 Apr 2023 17:50:01 +0300 Subject: [PATCH] docs(website): move documentation to the website https://git-cliff.org --- .dockerignore | 1 + .github/workflows/ci.yml | 4 +- README.md | 906 +- _config.yml | 1 - website/.gitignore | 20 + website/README.md | 41 + website/babel.config.js | 3 + website/blog/authors.yml | 5 + website/blog/git-cliff-0.5.0.md | 291 + website/docs/configuration.md | 278 + website/docs/docker.md | 33 + website/docs/github-actions/_category_.json | 7 + .../docs/github-actions/git-cliff-action.md | 22 + .../docs/github-actions/setup-git-cliff.md | 19 + .../github-actions/tj-actions-git-cliff.md | 17 + website/docs/gitlab.md | 26 + website/docs/index.md | 40 + website/docs/installation/binary-releases.md | 43 + .../docs/installation/build-from-source.md | 40 + website/docs/installation/crates-io.md | 9 + website/docs/installation/index.md | 11 + website/docs/installation/macports.md | 9 + website/docs/installation/npm.md | 19 + website/docs/installation/pacman.md | 7 + website/docs/integration/_category_.json | 7 + website/docs/integration/python.md | 21 + website/docs/integration/rust.md | 28 + website/docs/templating/_category_.json | 8 + website/docs/templating/context.md | 152 + website/docs/templating/examples.md | 722 + website/docs/templating/syntax.md | 22 + website/docs/usage/examples.md | 124 + website/docs/usage/usage.md | 45 + website/docusaurus.config.js | 142 + website/package-lock.json | 21702 ++++++++++++++++ website/package.json | 46 + website/sidebars.js | 33 + .../src/components/HomepageFeatures/index.tsx | 69 + .../HomepageFeatures/styles.module.css | 16 + website/src/css/custom.css | 32 + website/src/pages/index.module.css | 56 + website/src/pages/index.tsx | 87 + website/static/.nojekyll | 0 .../static/favicon/android-chrome-192x192.png | Bin 0 -> 27419 bytes .../static/favicon/android-chrome-512x512.png | Bin 0 -> 128108 bytes website/static/favicon/apple-touch-icon.png | Bin 0 -> 24801 bytes website/static/favicon/favicon-16x16.png | Bin 0 -> 716 bytes website/static/favicon/favicon-32x32.png | Bin 0 -> 1698 bytes website/static/favicon/favicon.ico | Bin 0 -> 15406 bytes website/static/favicon/site.webmanifest | 1 + website/static/fonts/aAngkanyaSebelas.ttf | Bin 0 -> 22172 bytes website/static/img/demo.png | Bin 0 -> 1076081 bytes website/static/img/git-cliff-social-card.jpg | Bin 0 -> 92878 bytes website/static/img/git-cliff.png | Bin 0 -> 136039 bytes website/static/img/logo.png | Bin 0 -> 43290 bytes website/tsconfig.json | 7 + website/yarn.lock | 7620 ++++++ 57 files changed, 31887 insertions(+), 905 deletions(-) delete mode 100644 _config.yml create mode 100644 website/.gitignore create mode 100644 website/README.md create mode 100644 website/babel.config.js create mode 100644 website/blog/authors.yml create mode 100644 website/blog/git-cliff-0.5.0.md create mode 100644 website/docs/configuration.md create mode 100644 website/docs/docker.md create mode 100644 website/docs/github-actions/_category_.json create mode 100644 website/docs/github-actions/git-cliff-action.md create mode 100644 website/docs/github-actions/setup-git-cliff.md create mode 100644 website/docs/github-actions/tj-actions-git-cliff.md create mode 100644 website/docs/gitlab.md create mode 100644 website/docs/index.md create mode 100644 website/docs/installation/binary-releases.md create mode 100644 website/docs/installation/build-from-source.md create mode 100644 website/docs/installation/crates-io.md create mode 100644 website/docs/installation/index.md create mode 100644 website/docs/installation/macports.md create mode 100644 website/docs/installation/npm.md create mode 100644 website/docs/installation/pacman.md create mode 100644 website/docs/integration/_category_.json create mode 100644 website/docs/integration/python.md create mode 100644 website/docs/integration/rust.md create mode 100644 website/docs/templating/_category_.json create mode 100644 website/docs/templating/context.md create mode 100644 website/docs/templating/examples.md create mode 100644 website/docs/templating/syntax.md create mode 100644 website/docs/usage/examples.md create mode 100644 website/docs/usage/usage.md create mode 100644 website/docusaurus.config.js create mode 100644 website/package-lock.json create mode 100644 website/package.json create mode 100644 website/sidebars.js create mode 100644 website/src/components/HomepageFeatures/index.tsx create mode 100644 website/src/components/HomepageFeatures/styles.module.css create mode 100644 website/src/css/custom.css create mode 100644 website/src/pages/index.module.css create mode 100644 website/src/pages/index.tsx create mode 100644 website/static/.nojekyll create mode 100644 website/static/favicon/android-chrome-192x192.png create mode 100644 website/static/favicon/android-chrome-512x512.png create mode 100644 website/static/favicon/apple-touch-icon.png create mode 100644 website/static/favicon/favicon-16x16.png create mode 100644 website/static/favicon/favicon-32x32.png create mode 100644 website/static/favicon/favicon.ico create mode 100644 website/static/favicon/site.webmanifest create mode 100644 website/static/fonts/aAngkanyaSebelas.ttf create mode 100644 website/static/img/demo.png create mode 100644 website/static/img/git-cliff-social-card.jpg create mode 100644 website/static/img/git-cliff.png create mode 100644 website/static/img/logo.png create mode 100644 website/tsconfig.json create mode 100644 website/yarn.lock diff --git a/.dockerignore b/.dockerignore index 8e4fa8db9a..f672795a62 100644 --- a/.dockerignore +++ b/.dockerignore @@ -2,6 +2,7 @@ /.git/ /.github/ /npm/ +/website/ # Files .editorconfig diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a1df1f5340..174bb75604 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -100,7 +100,9 @@ jobs: - name: Check the links uses: lycheeverse/lychee-action@v1 with: - args: --exclude "%7Busername%7D|file:///|https://datatracker.ietf.org|protonmail" -v *.md + args: > + --exclude "%7Busername%7D|file:///|https://datatracker.ietf.org|protonmail" + -v *.md website/docs/* website/blog/* env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index 8ea18d5fea..fdf586a11d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- +
@@ -39,909 +39,9 @@ ![preview](https://user-images.githubusercontent.com/24392180/128637997-5713ba25-d8f3-40c7-8ba8-ea7f333ead88.png) -

- Table of Contents +## Documentation - - -- [Installation](#installation) - - [From crates.io](#from-cratesio) - - [Using pacman](#using-pacman) - - [From NPM](#from-npm) - - [From MacPorts](#from-macports) - - [Binary releases](#binary-releases) - - [Build from source](#build-from-source) -- [Usage](#usage) - - [Command Line Arguments](#command-line-arguments) - - [Examples](#examples) -- [Docker](#docker) -- [GitHub Actions](#github-actions) - - [git-cliff-action](#git-cliff-action) - - [setup-git-cliff](#setup-git-cliff) -- [GitLab CI/CD](#gitlab-cicd) -- [Configuration File](#configuration-file) - - [changelog](#changelog) - - [header](#header) - - [body](#body) - - [trim](#trim) - - [footer](#footer) - - [git](#git) - - [conventional_commits](#conventional_commits) - - [filter_unconventional](#filter_unconventional) - - [split_commits](#split_commits) - - [commit_preprocessors](#commit_preprocessors) - - [commit_parsers](#commit_parsers) - - [protect_breaking_commits](#protect_breaking_commits) - - [filter_commits](#filter_commits) - - [tag_pattern](#tag_pattern) - - [skip_tags](#skip_tags) - - [ignore_tags](#ignore_tags) - - [topo_order](#topo_order) - - [sort_commits](#sort_commits) - - [link_parsers](#link_parsers) - - [limit_commits](#limit_commits) -- [Project Integration](#project-integration) - - [Rust](#rust) - - [Python](#python) -- [Templating](#templating) - - [Context](#context) - - [Conventional Commits](#conventional-commits) - - [Footers](#footers) - - [Breaking Changes](#breaking-changes) - - [Committer vs Author](#committer-vs-author) - - [Non-Conventional Commits](#non-conventional-commits) - - [Syntax](#syntax) - - [Examples](#examples-1) -- [In The Media](#in-the-media) -- [Similar/Related Projects](#similarrelated-projects) -- [License](#license) -- [Copyright](#copyright) - - - -
- -## Installation - -
- Packaging status - -[![Packaging status](https://repology.org/badge/vertical-allrepos/git-cliff.svg)](https://repology.org/project/git-cliff/versions) - -
- -### From crates.io - -[git-cliff](crates.io/crates/git-cliff) can be installed from crates.io: - -```sh -cargo install git-cliff -``` - -Minimum supported Rust version is `1.60.0`. - -### Using pacman - -If you are using Arch Linux, **git-cliff** can be installed from the [community repository](https://archlinux.org/packages/community/x86_64/git-cliff/): - -```sh -pacman -S git-cliff -``` - -### From NPM - -You can install and run [git-cliff](https://www.npmjs.com/package/git-cliff) with a single command: - -```sh -npx git-cliff@latest -``` - -Also, if you want to add `git-cliff` to your project: - -```sh -# with yarn -yarn add -D git-cliff - -# with npm -npm install git-cliff --save-dev -``` - -Afterwards, you can run `git-cliff` via `npm exec git-cliff` or `npx git-cliff@latest`. - -### From MacPorts - -On macOS, **git-cliff** can be installed via [MacPorts](https://www.macports.org): - -```sh -sudo port install git-cliff -``` - -[Port page](https://ports.macports.org/port/git-cliff/) - -### Binary releases - -See the available binaries for different operating systems/architectures from the [releases page](https://github.com/orhun/git-cliff/releases). - -\* Release tarballs are signed with the following PGP key: [1D2D410A741137EBC544826F4A92FA17B6619297](https://keyserver.ubuntu.com/pks/lookup?search=0x4A92FA17B6619297&op=vindex) - -### Build from source - -- Linux dependencies: [zlib](https://zlib.net/) - -```sh -# binary will be located at `target/release/git-cliff` -CARGO_TARGET_DIR=target cargo build --release -``` - -## Usage - -### Command Line Arguments - -``` -git-cliff [FLAGS] [OPTIONS] [--] [RANGE] -``` - -**Flags:** - -``` --v, --verbose Increases the logging verbosity --i, --init Writes the default configuration file to cliff.toml --l, --latest Processes the commits starting from the latest tag - --current Processes the commits that belong to the current tag --u, --unreleased Processes the commits that do not belong to a tag - --topo-order Sorts the tags topologically - --context Prints changelog context as JSON --h, --help Prints help information --V, --version Prints version information -``` - -**Options:** - -``` --c, --config Sets the configuration file [env: GIT_CLIFF_CONFIG=] [default: cliff.toml] --w, --workdir Sets the working directory [env: GIT_CLIFF_WORKDIR=] --r, --repository ... Sets the git repository [env: GIT_CLIFF_REPOSITORY=] - --include-path ... Sets the path to include related commits [env: GIT_CLIFF_INCLUDE_PATH=] - --exclude-path ... Sets the path to exclude related commits [env: GIT_CLIFF_EXCLUDE_PATH=] - --with-commit ... Sets custom commit messages to include in the changelog [env: GIT_CLIFF_WITH_COMMIT=] --p, --prepend Prepends entries to the given changelog file [env: GIT_CLIFF_PREPEND=] --o, --output Writes output to the given file [env: GIT_CLIFF_OUTPUT=] --t, --tag Sets the tag for the latest version [env: GIT_CLIFF_TAG=] --b, --body