Skip to content

Commit 374f5af

Browse files
authored
Fix README formatting on github pages (#97)
For some reason the default markdown rendering on github pages is different to the normal repo home page. * Add _config.yml to specify markdown version and to render markdown in html detail/summary blocks * Specify markdown='span' in summary because it said to in jekyll/jekyll#9297 * Fix copy/paste mistake in sample query. Unrelated but while the page is being edited anyway
1 parent a7a28cc commit 374f5af

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ cargo run schema
5959
## Queries
6060

6161
<details>
62-
<summary>Testing queries from terminal</summary>
62+
<summary markdown="span">Testing queries from terminal</summary>
6363

6464
While the graphiql front-end can be useful for exploring the API schema, running
6565
from the terminal is sometimes quicker/easier. This only requires `curl`
@@ -71,7 +71,7 @@ JSON object as `{"query": "<query-string>"}` taking care to escape quotes as
7171
required. Using `curl` and a basic visit directory query (see below), this
7272
looks something like
7373
```bash
74-
echo '{ 17:15:56
74+
echo '{
7575
"query": "{
7676
paths(beamline: \"i22\", visit: \"cm37278-5\") {
7777
directory

_config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Configuration for converting the README to a legible github pages page
2+
markdown: kramdown
3+
kramdown:
4+
parse_block_html: true

0 commit comments

Comments
 (0)