Commit eb8867e4 authored by Stephan Botta's avatar Stephan Botta
Browse files

Update README.adoc

parent 333b54fa
Pipeline #19930 passed with stages
in 1 minute and 2 seconds
...@@ -574,3 +574,65 @@ Ergebnis: ...@@ -574,3 +574,65 @@ Ergebnis:
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et .. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et ..
===== =====
==== ====
=== Einfügen von Quellcode
Asciidoctor bietet die Möglichkeit Quellcode in die Dokumentation einzufügen. Dabei kann der darzustellende Code entweder direkt eingefügt werden,
oder in Form eines Verweises auf eine externe Datei eingefügt werden.
==== Direkt
.Syntax,allgemein
-----
[source, Sprache]
----
Quellcode
----
-----
Ergebnis.
[source, Sprache]
----
Quellcode
----
.Beispiel
-----
[source,Python]
----
x=2
y=x*2
print("x:", x)
print("y:", y)
----
-----
.Ergebnis:
[source,Python]
----
x=2
y=x*2
print("x:", x)
print("y:", y)
----
==== Verweis auf Quelldatei
Dies geschieht in Form einer sogenannten _include_ Anweisungen, bei der dann direkt der Quellcode verlinkt ist. Das hat den Vorteil, dass die Dokumentation immer den aktuellen Quellcode enthält!
.Syntax:
-----
[source, python]
----
\include::https://gitlab.desy.de/fs-petra-upm/recovib/-/raw/master/config.py?inline=false[]
----
-----
.Ergebnis
[source, python]
----
include::https://gitlab.desy.de/fs-petra-upm/recovib/-/raw/master/config.py?inline=false[]
----
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment