Skip to content

Start adding markdown #3643

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Start adding markdown #3643

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
142adac
Start
HansOlsson Jan 24, 2025
ece6218
Add reference for GitHub flavored markdown.
HansOlsson Jan 29, 2025
fa9d427
Merge branch 'master' into AddMarkdown
HansOlsson Jun 23, 2025
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
5 changes: 3 additions & 2 deletions chapters/annotations.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,9 @@ \subsection{Class Description and Revision History}\label{annotation-info-revisi
The \lstinline!revisions! documentation may be omitted in printed documentation.
\end{nonnormative}

If the string starts with the tag \lstinline!<html>! or \lstinline!<HTML>!, the entire string is HTML encoded (assumed to end with \lstinline!</html>! or \lstinline!</HTML>!, but to be rendered as HTML even if the end-tag is missing).
Otherwise, the entire string is rendered as is.
If the string starts with the tag \lstinline!<html>! or \lstinline!<HTML>! the entire string is HTML encoded (and is assumed to end with \lstinline!</html>! or \lstinline!</HTML>! and shall be rendered as HTML even if the end-tags are missing).
Otherwise the entire string is seen as GitHub flavored markdown \textcite{GitHubFlavoredMarkdown}, including display math using a subset of \LaTeX.
For backwards compatibility non-HTML text can be rendered as is instead of as markdown.
HTML encoded content may contain links.
Modelica URIs may be used to refer to external resources (see \cref{external-resources}), as well as to refer to Modelica classes, e.g.,
\begin{lstlisting}[language=modelica]
Expand Down
7 changes: 7 additions & 0 deletions mls.bib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,10 @@ @InProceedings{Buerger2019SelectiveModel
address = {Regensburg, Germany},
doi = {10.3384/ecp19157277},
}

@Manual{GitHubFlavoredMarkdown,
author = {MacFarlane, John and others},
title = {GitHub Flavored Markdown Spec, Version 0.29-gfm},
year = {2019},
url = {https://github.github.com/gfm/},
}