Upsource supports Markdown in review and discussion comments. Here is the syntax to follow:
Emphasis
A theme based on VMware's Clarity Design System for publishing technical blogs with Hugo. Documentation for GitLab Community Edition, GitLab Enterprise Edition, Omnibus GitLab, and GitLab Runner. The forum uses Markdown, here's the syntax: Markdown syntax Quick guide by fluffypony Italics -.text. Bold -.text. Inline image -!alt text(http://im.
| Formatting | Entered text | Published text |
|---|---|---|
| Bold |
| This text is bold |
| Italic |
| This text is italic |
| Strikethrough | ~~Never mind~~ | Never mind |
Headings
| Formatting | Entered text | Published text |
|---|---|---|
| Level 1 header | # Level 1 header | |
| Level 2 header | ## Level 2 header | |
| Level 3 header | ### Level 3 header | Level 3 header |
Links
| Formatting | Entered text | Published text |
|---|---|---|
| External link autoconverted | http://jetbrains.com | http://jetbrains.com |
| External link with alias | [JetBrains, Inc.](http://jetbrains.com) | JetBrains, Inc. |
Horizontal rules
| Entered | Published |
|---|---|
___ | ________________ |
--- | ________________ |
Lists
Markdown Syntax Guide English
| Formatting | Entered text | Published text |
|---|---|---|
| Unordered list |
| |
| Ordered list | 1. Entry 2. Entry 3. Entry |
|
Task lists
Task lists are available in version 2018.1 and higher.
| Formatting | Entered text | Published text |
|---|---|---|
| Task list | - [x] Examine code - [ ] Commit fixes - [ ] Request a review | |
| Selected checkbox | ||
| Unselected checkbox | - [ ] Examine code |
Tables
| Formatting | Entered | Published | ||||||
|---|---|---|---|---|---|---|---|---|
| Not aligned | | Column header 1 | Column header 2 | | ---------------|----------------| | content 1 |content 2| | content 1 |content 2| |
| ||||||
| Right aligned | | Column header 1 | Column header 2 | | --------------:|---------------:| | content 1 |content 2| | content 1 |content 2| |
|
Reply quotation
| Formatting | Entered text | Published text |
|---|---|---|
| Blockquotes (can be nested) |
Code
| Formatting | Entered text | Published text |
|---|---|---|
| Code block | someCode someCode | |
| Inline code | `someCode` | someCode |
Images
| Entered | Published |
|---|---|
 |
Want to get involved in /web? We love ourcontributors. By submitting bug reports, pull requests andhelping to translate content into more than 15 differentlanguages, you've helped to make /web and the web better!
Found an issue or something need to be updated?
You can file an issue onour GitHub repository andsomeone will take a look, or you can fix it yourself by submitting apull request!
Want to help translate content?
Translating content is a great place to start! Check out ourtranslation guidelines for more details on how to get started.
Submitting a pull request
We'd love to accept your code patches! However, before we can take them, we have to jump a couple of legal hurdles.
Contributor License Agreements
Please fill out either the individual or corporate Contributor License Agreement.
- If you are an individual writing original source code and you're sure you own the intellectual property, then sign an individual CLA.
- If you work for a company that wants to allow you to contribute your work, then sign a corporate CLA.
Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it.
- Sign the contributors license agreement above.
- Decide which code you want to submit. A submission should be a set of changesthat addresses one issue in the issue tracker.Please don't mix more than one logical change per submission, because it makesthe history hard to follow. If you want to make a change(e.g. add a sample or feature) that doesn't have a corresponding issue in theissue tracker, please create one.
- Submitting: When you are ready to submit, send us a Pull Request. Besure to include the issue number you've fixed and the name you used to signthe CLA.
Article Styles
Looking for the sample article andmarkdown syntax guide, this is it.
Code Styles
If your contribution contains code, please make sure that it follows the style guide.Otherwise, we will have to ask you to make changes, and that's no fun for anyone.
Other Tips
Markdown Sheet
To simplify PR reviews, please word-wrap HTML files at 80 characters or fewer.