Skip to content

Simplify notes and versions#113

Merged
fsimonis merged 6 commits intomasterfrom
simplify-notes-and-versions
Jan 27, 2022
Merged

Simplify notes and versions#113
fsimonis merged 6 commits intomasterfrom
simplify-notes-and-versions

Conversation

@fsimonis
Copy link
Copy Markdown
Member

@fsimonis fsimonis commented Jan 18, 2022

This PR adds Liquid blocks for notes, warnings, tips, disclaimers and version information.

This simplifies writing notes etc to more natural syntax:

{% note %}
This is my note.
{% endnote %}

note: the icons don't render locally for some reason
image
image

I will migrate adapter notes once this PR is merged.

@fsimonis fsimonis requested review from MakisH and chlorenz January 18, 2022 12:21
@fsimonis fsimonis force-pushed the simplify-notes-and-versions branch from fe0cb0b to 0bb9d77 Compare January 18, 2022 12:35
@fsimonis fsimonis force-pushed the simplify-notes-and-versions branch from 3826bde to 645f457 Compare January 19, 2022 11:34
@fsimonis
Copy link
Copy Markdown
Member Author

After a discussion with @uekerman, I replaced the version_since tag with a version block.
This allows to enter free text, which covers more use-cases.
I updated the images in the PR.

@MakisH
Copy link
Copy Markdown
Member

MakisH commented Jan 25, 2022

I tried building locally, but I get a related error even in a clean copy of the repository. Do I maybe need a newer version of Jekyll? In any case, we should document it.

$ bundle exec jekyll serve --safe -l
Configuration file: /home/makish/Desktop/precice.github.io/_config.yml
            Source: /home/makish/Desktop/precice.github.io
       Destination: /home/makish/Desktop/precice.github.io/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
  Liquid Exception: Liquid syntax error (line 1): Unknown tag 'warning' in pages/docs/adapters/calculix/adapter-calculix-supermuc.md
                    ------------------------------------------------
      Jekyll 4.1.1   Please append `--trace` to the `serve` command 
                     for any additional information or backtrace. 
                    ------------------------------------------------

I am using Jekyll 4.1.1, Ruby 2.7.0, on Ubuntu 21.10.

Note that we don't have a website build check here. (related to #107)

@fsimonis
Copy link
Copy Markdown
Member Author

@MakisH We don't use the jekyll safe mode since we incorporated the tutorials.
Its disables custom plugins, hence the missing tag.

@MakisH
Copy link
Copy Markdown
Member

MakisH commented Jan 26, 2022

@MakisH We don't use the jekyll safe mode since we incorporated the tutorials. Its disables custom plugins, hence the missing tag.

Right, I had a feeling that we changed that at some point. Can you please also update the README, then?

@fsimonis fsimonis merged commit 95d5c87 into master Jan 27, 2022
@fsimonis fsimonis deleted the simplify-notes-and-versions branch January 27, 2022 10:48
@fsimonis
Copy link
Copy Markdown
Member Author

@MakisH Right. I fixed it directly on master b0639ed

@chlorenz
Copy link
Copy Markdown
Collaborator

Nice work @fsimonis !

I've added a whitespace after the icon for the version blocks in 7086a22.

BenjaminRodenberg added a commit that referenced this pull request Feb 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

3 participants