Skip to content

GitLab Next

    • GitLab: the DevOps platform
    • Explore GitLab
    • Install GitLab
    • How GitLab compares
    • Get started
    • GitLab docs
    • GitLab Learn
  • Pricing
  • Talk to an expert
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
    • Menu
    Projects Groups Snippets
  • Sign up now
  • Login
  • Sign in / Register
  • GitLab FOSS GitLab FOSS
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 0
    • Merge requests 0
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Code review
    • Insights
    • Issue
    • Repository
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar

GitLab 15.0 is launching on May 22! This version brings many exciting improvements, but also removes deprecated features and introduces breaking changes that may impact your workflow. To see what is being deprecated and removed, please visit Breaking changes in 15.0 and Deprecations.

  • GitLab.org
  • GitLab FOSSGitLab FOSS
  • Merge requests
  • !15107

Add support of Mermaid

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged
blackst0ne requested to merge feature_add_mermaid into master Oct 31, 2017
  • Overview 72
  • Commits 1
  • Pipelines 21
  • Changes 19

What does this MR do?

This MR adds support of Mermaid - a tool for generation of diagrams and flowcharts from text.

Known issues

The original mermaid library breaks current GitLab's layout including SVG elements.
The upstream has a bugfix for it which is not merged yet (low maintainers activity).
So until the fix is merged, I have created a forked version of mermaid with all needed fixes (an npm package is published too).

Once the upstream is updated, we should remove the fork and use the original library.

Why was this MR needed?

It adds an ability to draw charts right inside GItLab.

Screenshots (if relevant)

image

todo

  • Add screenshots
  • Test mermaid in wiki pages
  • Test mermaid in files
  • Test mermaid in snippets
  • Force this upstream PR to be merged or fix the bug in GitLab.
  • Add backend specs
  • Add frontend specs
  • Update documentation (markdown help page).

Does this MR meet the acceptance criteria?

  • Changelog entry added, if necessary
  • Documentation created/updated
  • API support added
  • Tests added for this feature/bug
  • Review
    • Has been reviewed by UX
    • Has been reviewed by Frontend
    • Has been reviewed by Backend
    • Has been reviewed by Database
  • Conform by the merge request performance guides
  • Conform by the style guides
  • Squashed related commits together

What are the relevant issue numbers?

Closes #3711 (closed)

Edited Nov 22, 2017 by blackst0ne
Assignee
Assign to
Reviewer
Request review from
Time tracking
Source branch: feature_add_mermaid