Commit 7d2432dc authored by Fabian Riethmayer's avatar Fabian Riethmayer

mini howto for adding examples into the hig

parent beb3556b
......@@ -4,7 +4,9 @@ Contribute
The HIG is written in
`reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_, a
lightweight markup language. For example the chapter heading together with the
first paragraph looks like this in reStructuredText::
first paragraph looks like this in reStructuredText
.. code-block:: rst
Contribute
==========
......@@ -194,3 +196,16 @@ Optional: you can add subsections for desktop and mobile.
Mobile
""""""
Code examples
-------------
Adding examples to the HIG is very easy.
#. Add a file with source code in the ``./examples/`` folder.
#. Add the following markup at the point you want to insert the example:
.. code-block:: rst
.. literalinclude:: /../../examples/kirigami/InlineMessage.qml
:language: qml
Markdown is supported
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