add syntax highlighting

ReproNim · Mar 20, 2024 · b435918 · b435918
1 parent c859504
commit b435918
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 7 deletions.
diff --git a/docs/20_project_structure.md b/docs/20_project_structure.md
@@ -33,7 +33,7 @@ The ReproSchema is like a blueprint for research projects, ensuring everyone col
 
 There is also an [`example`](https://github.com/ReproNim/reproschema/tree/master/examples)
 schema that can help give you a quick overview of what the protocol and activity
-for a study might look like. For more details see the [schema section](../docs/30_schema.md).
+for a study might look like. For more details see the [schema section](30_schema.md).
 
 ## [reproschema-library](https://github.com/ReproNim/reproschema-library)
 
@@ -72,7 +72,7 @@ You can see it in action [here](https://www.repronim.org/reproschema-ui/)
 
 ## [reproschema-protocol-cookiecutter](https://github.com/ReproNim/reproschema-protocol-cookiecutter)
 
-The reproschema-protocol-cookiecutter is a straightforward tool that helps you quickly set up a research study. It offers a ready-to-use template for organizing your study's structure and surveys, ensuring everything meets standard guidelines. Think of it as a quick-start guide to get your research project up and running smoothly. A step-by-step guide see [here](../docs/41_create_new_protocol.md).
+The reproschema-protocol-cookiecutter is a straightforward tool that helps you quickly set up a research study. It offers a ready-to-use template for organizing your study's structure and surveys, ensuring everything meets standard guidelines. Think of it as a quick-start guide to get your research project up and running smoothly. A step-by-step guide see [here](41_create_new_protocol.md).
 
 ## Other repositories
 

diff --git a/docs/52_create_new_activity.md b/docs/52_create_new_activity.md
@@ -434,7 +434,7 @@ touch activities/items/EHI_results.jsonld
   "description": "a study on linguistic processing in depression",
   "schemaVersion": "1.0.0-rc1",
   "version": "0.0.1",
-  "landingPage": {EHI
+  "landingPage": {
     "@id": "README.md",
     "@language": "en"
   },

diff --git a/docs/53_tips_to_make_your_life_easier.md b/docs/53_tips_to_make_your_life_easier.md
@@ -8,7 +8,7 @@
 
 First, make sure your syntax is in correct jsonld format. Test all files with `@context` from command line:
 
-```
+```bash
 npm install -g jsonlint
 grep -r "@context" . \
    | cut -d: -f1 | xargs -I fname jsonlint -q fname
@@ -23,7 +23,7 @@ Or test individual files on the [json linter website](`https://jsonlint.com/`).
 - mention that it needs python and add a pointer to reproschema-py
 -->
 
-```
+```bash
 pip install reproschema requests_cache
 reproschema -l DEBUG validate activities
 ```
@@ -46,7 +46,7 @@ To set those up you simply need to create a `.github/workflows` folder inside th
 
 For example you could create a `validate.yml` file in this repository.
 
-```bash
+```
 ├── .git # hidden git folder
 ├── .github # hidden github folder
 │    └── workflows
@@ -138,7 +138,7 @@ If you have to create several items that always have the same set of response op
 
 For example, you could create response set file to constrains the possible answers on the questions of the Edinburgh Handedness Inventory we have been working on by organizing things this way.
 
-```bash
+```
 activities
 ├── edinburgh_handedness_inventory_short.jsonld
 ├── leftRightValueConstraints.jsonld

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -49,3 +49,10 @@ markdown_extensions:
   - admonition
   - pymdownx.details
   - pymdownx.critic
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences