Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Markdown formatting #409

Merged
merged 3 commits into from
Mar 13, 2024
Merged

Improve Markdown formatting #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d82ac81
Adjust spacing to make code blocks blocks and add language hints
adamnovak Mar 13, 2024
4201386
Upgrade Markdown renderer
adamnovak Mar 13, 2024
cf5eb67
Remove trailing comma
adamnovak Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"fs-extra": "^10.1.0",
"gbz-base": "^0.1.0-alpha.1",
"gh-pages": "^4.0.0",
"markdown-to-jsx": "^7.2.0",
"markdown-to-jsx": "^7.4.3",
"multer": "^1.4.5-lts.1",
"node-cron": "^3.0.2",
"patch-package": "^8.0.0",
Expand Down
19 changes: 11 additions & 8 deletions public/help/help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ Keys can use brackets to encode hierarchical structures such as arrays and objec

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

Example of an array of JSON objects:
```
object =
Example of an array of JSON objects:

```json
[
{
"a": "b",
Expand All @@ -56,7 +56,7 @@ object =
"e": {
"f": "g"
}
},
}
]
```

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

A track object in JSON format might look like this:
```

```json
{
"trackFile": "exampleData/internal/snp1kg-BRCA1.vg.xg",
"trackType": "graph",
Expand Down Expand Up @@ -140,7 +141,8 @@ This array's query string representation would be: `object[0][a]=b&object[1][c]=


Examples of links:
* Link with preexisting data:
* Link with preexisting data:

```
http://127.0.0.1:3001?
tracks[0][trackFile]=exampleData%2Finternal%2Fsnp1kg-BRCA1.vg.xg&
Expand All @@ -153,7 +155,8 @@ Examples of links:
dataType=built-in&
simplify=false
```
* Link with custom data:
* Link with custom data:

```
http://127.0.0.1:3001?
tracks[1][trackType]=graph&
Expand All @@ -170,4 +173,4 @@ Examples of links:
region=ref%3A2000-3000&
dataType=mounted%20files&
simplify=false
```
```
Loading