Skip to content

Commit

Permalink
README: add image synatx example
Browse files Browse the repository at this point in the history
  • Loading branch information
karlb committed Dec 28, 2023
1 parent bd03c59 commit 5584bc6
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 12 deletions.
7 changes: 7 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,13 @@ The resulting HTML-Code

<a href="http://s01.de/~gottox/index.cgi/proj_smu">smu - simple mark up</a></p>

Images
------

Images use a syntax similar to the one for links:

![optional alt text](http://example.com/image.png)

Lists
-----

Expand Down
30 changes: 18 additions & 12 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ <h2>Links</h2>
<p>The resulting HTML-Code</p>
<pre><code>&lt;a href=&quot;http://s01.de/~gottox/index.cgi/proj_smu&quot;&gt;smu - simple mark up&lt;/a&gt;&lt;/p&gt;
</code></pre>
<h2>Images</h2>
<p>Images use a syntax similar to the one for links:</p>
<pre><code>![optional alt text](http://example.com/image.png)
</code></pre>
<h2>Lists</h2>
<p>Defining lists is very straightforward:</p>
<pre><code>* Item 1
Expand Down Expand Up @@ -182,23 +186,23 @@ <h2>Code &amp; Blockquote</h2>
</ul>
<h2>Tables</h2>
<p>Tables can be generated with the following syntax:</p>
<table>
<tr><th>Heading1 </th><th>Heading2 </th></tr>
<tr><td>Cell 1 </td><td>Cell2 </td></tr>
</table>
<pre><code>| Heading1 | Heading2 |
| -------- | -------- |
| Cell 1 | Cell2 |
</code></pre>
<p>Aligning the columns make the input nicer to read, but is not necessary to get
correct table output. You could just write</p>
<table>
<tr><th>Heading1 </th><th>Heading2 </th></tr>
<tr><td>Cell 1 </td><td>Cell2 </td></tr>
</table>
<pre><code>| Heading1 | Heading2 |
| --- | --- |
| Cell 1 | Cell2 |
</code></pre>
<p>To align the content of table cells, use <code>|:--|</code> for left, <code>|--:|</code> for right
and <code>|:--:|</code> for centered alignment in the row which separates the header from
the table body.</p>
<table>
<tr><th style="text-align: left">Heading1 </th><th style="text-align: center">Heading2 </th><th style="text-align: right">Heading3 </th></tr>
<tr><td style="text-align: left">Left </td><td style="text-align: center">Center </td><td style="text-align: right">Right </td></tr>
</table>
<pre><code>| Heading1 | Heading2 | Heading3 |
| :------- | :------: | -------: |
| Left | Center | Right |
</code></pre>
<h2>Other interesting stuff</h2>
<ul>
<li><p>to insert a horizontal rule simple add <code>- - -</code> into an empty line:</p>
Expand Down Expand Up @@ -227,6 +231,8 @@ <h2>Other interesting stuff</h2>
one.
</code></pre>
</li>
<li><p>Text wrapped in <code>$</code> or <code>$$</code> is not processed so it can be used with MathJax</p>
</li>
</ul>
<h2>embed HTML</h2>
<p>You can include arbitrary HTML code in your documents. The HTML will be
Expand Down

0 comments on commit 5584bc6

Please sign in to comment.