CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/gitstatus

README.md

gitstatus

This package allows to include information about a git-repository into a document.

Introduction

If your -document is version-controlled with git, you might encounter situations, where you want to include some information of your git-repository into your -document - e.g. to keep track on who gave you feedback on which version of your document.

Options

  • gitdir - custom git dir (can be relative), (default is ".git/", meaning your document is in the top level of your repo)
  • watermark - watermark with branch + hash on top of page (default: don't use watermark)
  • nowatermark - same as watermark=false
  • novariables - disable creation of variables (default: false)

Variables

Apart from the option to add a watermark at the top of the page that mentions the current commit hash and branch-name, the package also provides variables with the same information for individual use. These variables are:

  • gitdir
  • gitcommit
  • gitbranch

About

Version

The package is currently at version v1.1.

Maintainer

The code is created and maintained by Maximilian Gruber.

License

This package is provided under the Project Public License (LPPL).

Download the contents of this package in one zip archive (285.4k).

gitstatus – Include Git information in the document as watermark or via variables

If your -document is version-controlled with git, you might encounter situations, where you want to include some information of your git-repository into your -document- e.g. to keep track on who gave you feedback on which version of your document.

This git-information can be included on every page by a watermark or (for custom needs) via provided variables.

Packagegitstatus
Home pagehttps://github.com/mgrub/gitstatus
Version1.1 2022-10-06
LicensesThe Project Public License 1.3
Copyright2022 Maximilian Gruber
MaintainerMaximilian Gruber
Contained inTeX Live as gitstatus
MiKTeX as gitstatus
TopicsWatermark
Decoration
...
Guest Book Sitemap Contact Contact Author