Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Proposed command to generate a table of contents #60

Closed
adoble opened this issue Sep 29, 2024 · 1 comment
Closed

Proposed command to generate a table of contents #60

adoble opened this issue Sep 29, 2024 · 1 comment
Assignees
@adoble
Labels
enhancement

Comments

@adoble
Copy link
Owner

adoble commented Sep 29, 2024

Usage

adr generate toc [-t TEMPLATE_FILE]

Description

Generate a table of contents (TOC) listing each ADR. The table of contents is generated in the same directory as the ADRs.

-t, -template TEMPLATE_FILE Optional template file used for the TOC. If no template is specified then:

  • The template specified with adr config tocTempateFile [path to template] is used.
  • If no template has been configured then a default template using markdown is generated.
@adoble adoble self-assigned this Sep 29, 2024
@adoble
Copy link
Owner Author

adoble commented Oct 25, 2024

Closed in release 3.4.0

@adoble adoble closed this as completed Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adoble adoble

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@adoble