Skip to content

Commit 14ea07b

Browse files
authored
Merge pull request #409 from vgteam/improve-markdown-formatting
Improve Markdown formatting
2 parents c223b71 + cf5eb67 commit 14ea07b

File tree

3 files changed

+19
-16
lines changed

3 files changed

+19
-16
lines changed

package-lock.json

+7-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"fs-extra": "^10.1.0",
3232
"gbz-base": "^0.1.0-alpha.1",
3333
"gh-pages": "^4.0.0",
34-
"markdown-to-jsx": "^7.2.0",
34+
"markdown-to-jsx": "^7.4.3",
3535
"multer": "^1.4.5-lts.1",
3636
"node-cron": "^3.0.2",
3737
"patch-package": "^8.0.0",

public/help/help.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Keys can use brackets to encode hierarchical structures such as arrays and objec
4444

4545
The key's name should **not** be in quotes.
4646

47-
Example of an array of JSON objects:
48-
```
49-
object =
47+
Example of an array of JSON objects:
48+
49+
```json
5050
[
5151
{
5252
"a": "b",
@@ -56,7 +56,7 @@ object =
5656
"e": {
5757
"f": "g"
5858
}
59-
},
59+
}
6060
]
6161
```
6262

@@ -69,7 +69,8 @@ This array's query string representation would be: `object[0][a]=b&object[1][c]=
6969
Array of tracks. Tracks are objects consisting of `trackFile`, `trackType`, and `trackColorSettings`.
7070

7171
A track object in JSON format might look like this:
72-
```
72+
73+
```json
7374
{
7475
"trackFile": "exampleData/internal/snp1kg-BRCA1.vg.xg",
7576
"trackType": "graph",
@@ -140,7 +141,8 @@ This array's query string representation would be: `object[0][a]=b&object[1][c]=
140141

141142

142143
Examples of links:
143-
* Link with preexisting data:
144+
* Link with preexisting data:
145+
144146
```
145147
http://127.0.0.1:3001?
146148
tracks[0][trackFile]=exampleData%2Finternal%2Fsnp1kg-BRCA1.vg.xg&
@@ -153,7 +155,8 @@ Examples of links:
153155
dataType=built-in&
154156
simplify=false
155157
```
156-
* Link with custom data:
158+
* Link with custom data:
159+
157160
```
158161
http://127.0.0.1:3001?
159162
tracks[1][trackType]=graph&
@@ -170,4 +173,4 @@ Examples of links:
170173
region=ref%3A2000-3000&
171174
dataType=mounted%20files&
172175
simplify=false
173-
```
176+
```

0 commit comments

Comments
 (0)