drewcassidy/yaclog
1
0
Fork 0
mirror of https://github.com/drewcassidy/yaclog.git synced 2024-09-01 14:58:58 +00:00
Code Issues Projects Releases Wiki Activity

header attribute on the changelog class has been split into title and preamble

Browse Source
This commit is contained in:
Andrew Cassidy
2021-05-06 22:23:35 -07:00
parent 4b11ab839d
commit a230968736
6 changed files with 60 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/handbook/changelog_files.md
View File

@ -2,9 +2,13 @@
Yaclog works on markdown changelog files, using a machine-readable format based on what is proposed by [Keep a Changelog](https://keepachangelog.com). Changelog files can be created using the {command}`yaclog init` command.
## Front Matter
## Title
The front matter, or header, of a changelog is the text at the top of the file before any version information. It can contain the file's title, an explanation of the file's purpose, as well as any general machine-readable information you may want to include for use with other tools. Yaclog does not provide any ways to manipulate the front matter from the command line due to its open-ended nature.
The title is the first H1 in the file giving its title, usually `# Changlog`.
## Preamble
The preamble is the text at the top of the file before any version information. It can contain an explanation of the file's purpose, as well as any general machine-readable information you may want to include for use with other tools. Yaclog does not provide any ways to manipulate the front matter from the command line due to its open-ended nature.
## Versions