Giter VIP home page Giter VIP logo

Comments (1)

koppor avatar koppor commented on August 16, 2024

Use YAML front matter

  • Good, because it shortens the body (essence of the ADR)
  • Good, because tools can handle it more easily
  • Good, because indicates the lower importance of the data
  • Bad, because pretends to be more accurate than it can be (e.g., possible status values)
  • Bad, because rendering not standardized
  • Bad, because not all Markdown parsers can parse it

Use plain markdown everywhere

  • Good, because all parsers can handle it
  • Bad, because special markdown parsing tooling is needed
  • Bad, because meta data is handled the same way as the content

from madr.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.