# great-docs changelog


Generate a Changelog page from GitHub Releases.


``` bash
great-docs changelog [OPTIONS]
```


Fetches published releases from the GitHub API and renders them as a `changelog.qmd` page in the build directory. The page is also linked in the navbar automatically.

Requires the project to have a GitHub repository URL in `pyproject.toml`. Set `GITHUB_TOKEN` or `GH_TOKEN` to avoid API rate limits.


<span class="gd-details-chevron" aria-hidden="true"></span>Full --help output


    Usage: great-docs changelog [OPTIONS]

      Generate a Changelog page from GitHub Releases.

      Fetches published releases from the GitHub API and renders them as a
      'changelog.qmd' page in the build directory. The page is also linked in the
      navbar automatically.

      Requires the project to have a GitHub repository URL in 'pyproject.toml'.
      Set 'GITHUB_TOKEN' or 'GH_TOKEN' to avoid API rate limits.

    Options:
      --project-path DIRECTORY  Path to your project root directory (default:
                                current directory)
      --max-releases INTEGER    Maximum number of releases to include (default:
                                from config or 50)
      --help                    Show this message and exit.


# Options


`--project-path: DIRECTORY`  
Path to your project root directory (default: current directory)

`--max-releases: INTEGER`  
Maximum number of releases to include (default: from config or 50)