Skip to content

GitLab Next

  • Menu
Projects Groups Snippets
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • GitLab Docs GitLab Docs
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 163
    • Issues 163
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
  • Merge requests 13
    • Merge requests 13
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • 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 DocsGitLab Docs
  • Issues
  • #50
Closed
Open
Created Nov 24, 2016 by Connor Shea@connorshea🏄

Switch to Kramdown

What

Right now we're using Redcarpet, but eventually we want to switch to Kramdown.

Any custom Redcarpet code we're currently using will need to be replaced (see lib/helpers_.rb). We'll also need to make sure everything still works with the new Markdown parser.

Why

With Kramdown we open a new world of possibilities in our docs site, making it as flexible as about.gitlab.com:

  • This is our markdown guide for GitLab and the docs site
  • This is our markdown guide for about.gitlab.com

Latest thread on Slack (2018-02-23): https://gitlab.slack.com/archives/C16HYA2P5/p1519332161000412

What can we do with Kramdown that we can't with Redcarpet

  • Add videos, JS code, HTML code, apply custom classes and ids to markdown files
  • Add the product badges inline to the docs (https://gitlab.com/gitlab-com/gitlab-docs/issues/173)
  • Play with images and illustrations (e.g., add icons to headers https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17429)
  • Use FontAwesome icons in markdown files
Edited Mar 21, 2018 by Marcia Ramos
Assignee
Assign to
Time tracking