GitUtils Extension
The "gitutils" extension provides a mechanism for gleaning information regarding the git repository that the documentation build command is being executed within.
Table 1: Configuration items for the "gitutils" extension.
Key | Default | Description |
---|---|---|
active | True | Toggle for disabling the extension. This only changes the initial active state, use setActive to control at runtime. |
Commit
The "commit" sub-command inserts the current commit SHA-1 for the repository of the working directory of the documentation build. Example 1 is an example that demonstrates the use of this command. The available settings for the this command are provided in Table 2.
Table 2: Available settings for the !git commit
command.
Key | Default | Description |
---|---|---|
style | None | The style settings that are passed to rendered HTML tag. |
class | None | The class settings to be passed to rendered HTML tag. |
id | None | The class settings to be passed to the rendered tag. |