madr
npm i madr

madr

Markdown Architectural Decision Records

by adr

2.1.2 (see all)License:CC0-1.0TypeScript:Not Found
npm i madr
Readme

Markdown Any Decision Records part of ADR

"Markdown Any Decision Records" (MADR) [ˈmæɾɚ] – decisions that matter [ˈmæɾɚ].

For user documentation, please head to https://adr.github.io/madr/.

Development Hints

How to start Jekyll locally

For rendedring the docs directory, Jekyll is needed.

For local development, follow the Jekyll installation instructions. Installing the latest version of ruby followed by gem install bundler should be enough.

Afterwards, run

bundle install
jekyll serve --livereload

and go to http://localhost:4000/madr/ in your browser.

On Windows, using a dockerized environment is recommended:

docker run -p 4000:4000 --rm --volume="C:\git-repositories\adr.github.io\madr\docs":/srv/jekyll jekyll/jekyll:4 jekyll serve

In case you get errors regarding Gemfile.lock, just delete Gemfile.lock and rerun.

Releasing a new version

  1. Update CHANGELOG.md.
  2. Update the example at docs/index.md.
  3. Update docs/decisions/* with the new template
  4. Check that the YAML front matter in docs/decisions/adr-template.md is kept.
  5. Copy .markdownlint.yml to template/.markdownlint.yml
  6. Adapt the version reference in template/0000-use-markdown-any-decision-records.md.
  7. Copy template/0000-use-markdown-any-decision-records.md to docs/decisions/0000-use-markdown-any-decision-records.md.
  8. Update package.json, publish to npmjs, create GitHub release.\ Use release-it (do not create a release on GitHub) and github-release-from-changelog.

License

This work is dual-licensed under MIT and CC0. You can choose between one of them if you use this work.

SPDX-License-Identifier: MIT OR CC0-1.0

Downloads/wk

4.8K

GitHub Stars

884

LAST COMMIT

4mos ago

MAINTAINERS

1

CONTRIBUTORS

11

OPEN ISSUES

8

OPEN PRs

0
VersionTagPublished
2.1.2
latest
3yrs ago
3.0.0-beta.2
beta
4d ago
No alternatives found
No tutorials found
Add a tutorial