npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

madr

v4.0.0

Published

Markdown Architectural Decision Records

Downloads

37,487

Readme

Markdown Architectural Decision Records

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

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

Quick start

Copy it into docs/decisions. For each ADR, copy the tempalte to nnnn-title.md and adapt. Longer explanation: Head to https://adr.github.io/madr/#applying-madr-to-your-project.

Development hints

Branches

| Branch | Meaning | |--------------|----------------------------------------------------------------------------------------------------------------------------------------------| | gh-pages | Homepage showing the latest released version, rendered at https://adr.github.io/madr | | develop | Latest developments, including homepage updates which should be published on a release. gh-pages should always be merged into this branch. | | release/vY | Branch for latest release Y.x version of MADR. Introduced to fix #92 |

The branch name conventions follow the git flow model.

See also CONTRIBUTING.md.

How to start Jekyll locally

For rendering 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 -v "C:\git-repositories\adr.github.io\madr\docs":/site bretfisher/jekyll-serve

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

Updating just-the-docs

Releasing a new version

  1. Update the examples at docs/index.md and docs/examples.md.
  2. Update the concrete decisions in docs/decisions/* with the new template.
  3. Commit ("Update examples and decisions") and push. Possibly as pull request.
  4. Adapt the version reference in template/0000-use-markdown-architectural-decision-records.md.
  5. Update "template" files in in docs/decisions:
    • Copy template/0000-use-markdown-architectural-decision-records.md to docs/decisions/0000-use-markdown-architectural-decision-records.md.
    • Adapt content of docs/decisions/adr-template.md based on template/adr-template.md. Thereby, ensure that the YAML front matter in docs/decisions/adr-template.md is kept.
  6. Add link to docs/index.md at "Older versions" (for the homepage).
  7. Copy .markdownlint.yml to template/.markdownlint.yml (and possibly to docs/.markdownlint.yml).
  8. Update CHANGELOG.md.
  9. Commit.
  10. Update package.json and publish to npmjs using release-it (do not create a release on GitHub). This also does a commit.
  11. Create GitHub release using github-release-from-changelog.
  12. Merge develop into gh-pages

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