Skip to content

Commit

Permalink
docs: test syntax highlighting in Getting Started guide
Browse files Browse the repository at this point in the history
  • Loading branch information
frademacher committed Aug 2, 2023
1 parent 94c7424 commit 22e9348
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/prepare_pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ on:
jobs:
build:
runs-on: ubuntu-latest
env:
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
name: Build and Push
steps:
- name: Checkout repo
Expand All @@ -25,6 +27,9 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
git clone https://monticore:[email protected]/se/infrastructure/monticore-pygments-highlighting.git
pip install -r ./monticore-pygments-highlighting/requirements.txt
pip install ./monticore-pygments-highlighting
- name: Preprocess the docs
run: sh docs/scripts/preprocessing.sh
Expand Down
6 changes: 3 additions & 3 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ form of extension allows to achieve several effects:
Component grammars and grammar extensions are detailedly discussed in
[Chapter 4 of the MontiCore handbook](https://www.monticore.de/handbook.pdf).

```
```monticore
grammar Automata extends de.monticore.MCBasics {
symbol scope Automaton =
Expand Down Expand Up @@ -223,7 +223,7 @@ the second usage is named `to`. MontiCore also supports `interface` and
described in [Chapter 4 of the MontiCore handbook](https://www.monticore.de/handbook.pdf).
However, the example grammar does not use these concepts.

```
```automaton
automaton PingPong {
state NoGame <<initial>>;
state Ping;
Expand Down Expand Up @@ -330,7 +330,7 @@ or archives
containing paths to grammars and Java classes that are imported by the
processed grammar and the related tooling. In this case, the archive
`monticore-rt.jar` contains the grammars and handwritten extensions
of the [monticore standard library](https://git.rwth-aachen.de/monticore/monticore/-/tree/dev/monticore-grammar/src/main).
of the monticore standard library.
More information about the standard library can be found in
[Chapters 17- 20 of the handbook](https://www.monticore.de/handbook.pdf).

Expand Down
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ extra_css:

copyright: '(c) https://github.com/MontiCore/monticore'

markdown_extensions:
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences

nav:
- Home: 'README.md'
- 'Getting Started': 'docs/GettingStarted.md'
Expand Down

0 comments on commit 22e9348

Please sign in to comment.