You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by gc...@apache.org on 2026/02/10 16:59:32 UTC

(allura) 01/01: updated Markdown syntax guide with a new example to make use of text rendering and updated the exmaple for lists

This is an automated email from the ASF dual-hosted git repository.

gcruz pushed a commit to branch gc/markdown-docs-update
in repository https://gitbox.apache.org/repos/asf/allura.git

commit de54c771312b78221cd38499577bd23be1e881b9
Author: Guillermo Cruz <gu...@slashdotmedia.com>
AuthorDate: Tue Feb 10 09:59:24 2026 -0700

    updated Markdown syntax guide with a new example to make use of text rendering and updated the exmaple for lists
---
 Allura/allura/templates/jinja_master/lib.html | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/Allura/allura/templates/jinja_master/lib.html b/Allura/allura/templates/jinja_master/lib.html
index fa37c98cb..7a2f3f1fc 100644
--- a/Allura/allura/templates/jinja_master/lib.html
+++ b/Allura/allura/templates/jinja_master/lib.html
@@ -462,12 +462,30 @@ Within a paragraph, you can use backquotes to do the same thing.
 
 Within a paragraph, you can use backquotes to do the same thing.
 `This won't be *italic* or **bold** at all.`""")}}
-</div>
+<h2>Preformatted Text Without Code Highlighting</h2>
+<p>You might have noticed in the above examples the tags &lt;b&gt; and &lt;i&gt; are being highlighted.
+    To remove any type of highlighting or prevent the text from being processed when using a code block of tildes or backticks, you can explicitly set the language to <i>text</i>.</p>
+<div class="codehilite"><pre>
+```text
+This <i>line</i> won't *have any markdown* formatting applied.
+```
+</pre></div>
+<br>
+{{ g.markdown.convert("""
+```text
+This <i>line</i> won't *have any markdown* formatting applied.
+```
+""") }}
+<p>View more information about <a href="#md_ex_code">code highlighting</a> or find out more about all the supported languages at <a href="https://pygments.org/docs/lexers/">Pygments docs</a>.</p>
 
+</div>
+<br>
 
 <div class="markdown_syntax_section hidden_in_modal md_ex_lists{{id}}">
 <h2 id="md_ex_lists{{id}}">Lists</h2>
-<div class="codehilite"><pre>* an asterisk starts an unordered list
+<div class="codehilite"><pre>
+This is an example paragraph introducing a list.
+* an asterisk starts an unordered list
 * and this is another item in the list
 + or you can also use the + character
 - or the - character
@@ -490,7 +508,8 @@ To start a check list, write this:
 </pre></div>
 
 <p>Output:</p>
-{{g.markdown.convert('''* an asterisk starts an unordered list
+{{g.markdown.convert('''This is an example paragraph introducing a list.
+* an asterisk starts an unordered list
 * and this is another item in the list
 + or you can also use the + character
 - or the - character