GitLab Next

Projects
Groups
Snippets
Help

Loading...
Help
Sign in / Register

GitLab FOSS

Project overview
Repository
Issues 1
Merge Requests 0
- Merge Requests 0
Requirements
Security & Compliance
Packages & Registries
Analytics
Snippets
- Snippets
Members
- Members

Collapse sidebar

Activity
Graph
Create a new issue
Commits
Issue Boards

GitLab.org
GitLab FOSS
Merge Requests
!15107

Merged

Opened Oct 31, 2017 by blackst0ne @blackst0ne7 of 19 tasks completed7/19 tasks

Report abuse

Report abuse

Add support of Mermaid

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)

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)

## What does this MR do?

This MR adds support of [Mermaid](https://github.com/knsv/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](https://github.com/knsv/mermaid/pull/577) for it which is not merged yet (low maintainers activity).  
So until the fix is merged, I have created [a forked version](https://github.com/blackst0ne/mermaid) of `mermaid` with all needed fixes ([an npm package](https://www.npmjs.com/package/blackst0ne-mermaid) 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](/uploads/11973b6a0c723e92e3ce2a783980b092/image.png)

## todo

* [x]  Add screenshots
* [x]  Test mermaid in wiki pages
* [x]  Test mermaid in files
* [x]  Test mermaid in snippets
* [ ]  Force [this upstream PR](https://github.com/knsv/mermaid/pull/577) to be merged or fix the bug in GitLab. 
* [x]  Add backend specs
* [ ]  Add frontend specs
* [x]  Update documentation (markdown help page).

## Does this MR meet the acceptance criteria?

- [x] [Changelog entry](https://docs.gitlab.com/ee/development/changelog.html) added, if necessary
- [ ] [Documentation created/updated](https://docs.gitlab.com/ee/development/doc_styleguide.html)
- [ ] 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](https://docs.gitlab.com/ee/development/merge_request_performance_guidelines.html)
- [ ] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [ ] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

## What are the relevant issue numbers?

Closes #3711

Edited Nov 22, 2017 by blackst0ne

Check out, review, and merge locally

Step 1. Fetch and check out the branch for this merge request

git fetch origin
git checkout -b "feature_add_mermaid" "origin/feature_add_mermaid"

Step 2. Review the changes locally

Step 3. Merge the branch and fix any conflicts that come up

git fetch origin
git checkout "origin/master"
git merge --no-ff "feature_add_mermaid"

Step 4. Push the result of the merge to GitLab

git push origin "master"

Note that pushing to GitLab requires write access to this repository.

Tip: You can also checkout merge requests locally by following these guidelines.

Assignee

Assign to

10.3

Milestone

10.3

Assign milestone

Time tracking

7

Labels

Community contribution Plan [DEPRECATED] banzai devopsplan feature highlight markdown

Assign labels

View project labels

Reference: gitlab-org/gitlab-foss!15107

Revert this merge request

This will create a new commit in order to revert the existing changes.

Revert in branch

Switch branch

Cancel

A new branch will be created in your fork and a new merge request will be started.

Cherry-pick this merge request

Pick into branch

Switch branch

Cancel

A new branch will be created in your fork and a new merge request will be started.