[go: up one dir, main page]

Markdown charts

Problem to solve

People should be able to easily embed charts in issue descriptions and comments, via markdown.

Further details

Leverage Chart.js as a markdown renderer. Parse the markdown content as YAML or JSON and pass to new Chart(). Or https://markvis.js.org/#/ which is based on d3.

Proposal

{
  "type": "bar",
  "data": {
  "labels": [
    "Red",
    "Blue",
    "Yellow",
    "Green",
    "Purple",
    "Orange"
  ],
  "datasets": [
    {
    "label": "# of Votes",
    "data": [
      12,
      19,
      3,
      5,
      2,
      3
    ],
    "backgroundColor": [
      "rgba(255, 99, 132, 0.2)",
      "rgba(54, 162, 235, 0.2)",
      "rgba(255, 206, 86, 0.2)",
      "rgba(75, 192, 192, 0.2)",
      "rgba(153, 102, 255, 0.2)",
      "rgba(255, 159, 64, 0.2)"
    ],
    "borderColor": [
      "rgba(255,99,132,1)",
      "rgba(54, 162, 235, 1)",
      "rgba(255, 206, 86, 1)",
      "rgba(75, 192, 192, 1)",
      "rgba(153, 102, 255, 1)",
      "rgba(255, 159, 64, 1)"
    ],
    "borderWidth": 1
    }
  ]
  },
  "options": {}
}

to render:

image

What does success look like, and how can we measure that?

  • Significant adoption of markdown charts; increased user satisfaction

Links / references

Edited by 🤖 GitLab Bot 🤖