Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • G gitlabhq1
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 21
    • Issues 21
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 12
    • Merge requests 12
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • gpt
  • large_projects
  • gitlabhq1
  • Merge requests
  • !6863

Closed
Created Apr 24, 2014 by Administrator@rootOwner
  • Report abuse
Report abuse

Update docs to match new markdown style guide.

  • Overview 56
  • Commits 1
  • Changes 88

Created by: cirosantilli

Now that we have a markdown style guide I've started updating the docs to match that guide.

I have updated part of the docs. Please check that this is OK, and if yes I will finish updating the rest of the guide.

If you don't agree with the style in guide, please open an issue / pull request directly at: https://github.com/cirosantilli/markdown-styleguide for us to discuss and link to it from here.

The main changes include:

  • don't wrap long lines: http://www.cirosantilli.com/markdown-styleguide/#line-wrapping

  • convert every list marker to -. Currently both + and * are used.

  • convert lists with paragraphs to triple spaces after marker:

    -   a
    
        b

    Greater portability: http://www.cirosantilli.com/markdown-styleguide/#spaces-after-marker

  • remove multiple consecutive empty lines

  • add top-level headers everywhere

Assignee
Assign to
Reviewer
Request review from
Time tracking
Source branch: github/fork/booktree/doc-md-style