Skip to content

Commit f38ca9b

Browse files
committed
tools: fix vdoc tests after the vlang/markdown -> html <h2 id="title-topic">Title Topic</h2> change
1 parent d169610 commit f38ca9b

1 file changed

Lines changed: 45 additions & 11 deletions

File tree

  • cmd/tools/vdoc/testdata/output_formats

‎cmd/tools/vdoc/testdata/output_formats/main.html‎

Lines changed: 45 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
11
<section id="readme_main" class="doc-node">
22
<div class="title"><h1> main <a href="#readme_main">#</a></h1></div>
3-
<h2>Description</h2><p>This is an example of a an .md file, used for adding more rich text documentation in a project or module.</p><p>This is a <a href="https://vlang.io/">link</a> to the main V site.</p><p>This is a <b>bold text</b>.</p><p>This is a script <code>&lt;script&gt;console.log('hi from README.md');&lt;/script&gt;</code> .</p><h2>Examples</h2><h3>Functions that return different literals:</h3><p>Example of a function returning boolean:</p><pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">is_odd</span><span class="token punctuation">(</span>x <span class="token builtin">int</span><span class="token punctuation">)</span> <span class="token builtin">bool</span> <span class="token punctuation">{</span>
3+
<h2 id="description">Description</h2>
4+
<p>This is an example of a an .md file, used for adding more rich text documentation in a project or module.</p>
5+
<p>This is a <a href="https://vlang.io/">link</a> to the main V site.</p>
6+
<p>This is a <b>bold text</b>.</p>
7+
<p>This is a script <code>&lt;script&gt;console.log('hi from README.md');&lt;/script&gt;</code> .</p>
8+
<h2 id="examples">Examples</h2>
9+
<h3 id="functions-that-return-different-literals">Functions that return different literals:</h3>
10+
<p>Example of a function returning boolean:</p>
11+
<pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">is_odd</span><span class="token punctuation">(</span>x <span class="token builtin">int</span><span class="token punctuation">)</span> <span class="token builtin">bool</span> <span class="token punctuation">{</span>
412
<span class="token keyword">if</span> x <span class="token operator">%</span> <span class="token number">2</span> <span class="token operator">==</span> <span class="token number">0</span> <span class="token punctuation">{</span>
513
<span class="token keyword">return</span> <span class="token boolean">false</span>
614
<span class="token punctuation">}</span>
715
<span class="token keyword">return</span> <span class="token boolean">true</span>
8-
<span class="token punctuation">}</span></code></pre><p>Another example of a function returning a string:</p><pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">answer</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token builtin">string</span> <span class="token punctuation">{</span>
16+
<span class="token punctuation">}</span></code></pre>
17+
<p>Another example of a function returning a string:</p>
18+
<pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">answer</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token builtin">string</span> <span class="token punctuation">{</span>
919
<span class="token keyword">return</span> <span class="token string">'42'</span>
10-
<span class="token punctuation">}</span></code></pre><p>This example shows a function returning a string with interpolation:</p><pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">str_with_interplation</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token builtin">string</span> <span class="token punctuation">{</span>
20+
<span class="token punctuation">}</span></code></pre>
21+
<p>This example shows a function returning a string with interpolation:</p>
22+
<pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">str_with_interplation</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token builtin">string</span> <span class="token punctuation">{</span>
1123
<span class="token keyword">return</span><span class="token string"> 'this string has </span><span class="token string_interp">$</span>{<span class="token number">42</span><span class="token punctuation">:</span><span class="token number">6</span>}<span class="token string"> interpolation in it.'</span>
12-
<span class="token punctuation">}</span></code></pre><h3>Processing command line args</h3><pre><code class="language-v"><span class="token keyword">import</span> os
24+
<span class="token punctuation">}</span></code></pre>
25+
<h3 id="processing-command-line-args">Processing command line args</h3>
26+
<pre><code class="language-v"><span class="token keyword">import</span> os
1327

1428
<span class="token keyword">fn</span> <span class="token function">main</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
1529
<span class="token keyword">dump</span><span class="token punctuation">(</span>os<span class="token punctuation">.</span>args<span class="token punctuation">)</span>
@@ -23,7 +37,9 @@ <h2>Description</h2><p>This is an example of a an .md file, used for adding more
2337

2438
ch <span class="token operator">:=</span> <span class="token builtin">chan</span> <span class="token builtin">bool</span><span class="token punctuation">{</span>cap<span class="token punctuation">:</span> <span class="token number">1</span><span class="token punctuation">}</span>
2539
ch <span class="token operator"><-</span> <span class="token boolean">true</span>
26-
<span class="token punctuation">}</span></code></pre><h3>A JWT example (test syntax highlighting)</h3><pre><code class="language-v"><span class="token keyword">import</span> crypto<span class="token punctuation">.</span>hmac
40+
<span class="token punctuation">}</span></code></pre>
41+
<h3 id="a-jwt-example-test-syntax-highlighting">A JWT example (test syntax highlighting)</h3>
42+
<pre><code class="language-v"><span class="token keyword">import</span> crypto<span class="token punctuation">.</span>hmac
2743
<span class="token keyword">import</span> crypto<span class="token punctuation">.</span>sha256
2844
<span class="token keyword">import</span> encoding<span class="token punctuation">.</span>base64
2945
<span class="token keyword">import</span> json
@@ -66,7 +82,9 @@ <h2>Description</h2><p>This is an example of a an .md file, used for adding more
6682
sha256<span class="token punctuation">.</span>sum<span class="token punctuation">,</span> sha256<span class="token punctuation">.</span>block_size<span class="token punctuation">)</span>
6783
signature_from_token <span class="token operator">:=</span> base64<span class="token punctuation">.</span><span class="token function">url_decode</span><span class="token punctuation">(</span>token_split<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
6884
<span class="token keyword">return</span> hmac<span class="token punctuation">.</span><span class="token function">equal</span><span class="token punctuation">(</span>signature_from_token<span class="token punctuation">,</span> signature_mirror<span class="token punctuation">)</span>
69-
<span class="token punctuation">}</span></code></pre><h3>Other language specifiers</h3><pre><code class="language-cpp">##
85+
<span class="token punctuation">}</span></code></pre>
86+
<h3 id="other-language-specifiers">Other language specifiers</h3>
87+
<pre><code class="language-cpp">##
7088
std<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token builtin">map</span><span class="token operator"><</span>std<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token builtin">string</span><span class="token punctuation">,</span> <span class="token builtin">int</span><span class="token operator">></span> <span class="token symbol">my_map</span> <span class="token punctuation">{</span>
7189
<span class="token punctuation">{</span><span class="token string">'KEY_1'</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
7290
<span class="token punctuation">{</span><span class="token string">'KEY_2'</span><span class="token punctuation">,</span> <span class="token number">10</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
@@ -75,8 +93,11 @@ <h2>Description</h2><p>This is an example of a an .md file, used for adding more
7593
<span class="token keyword">for</span> <span class="token punctuation">(</span><span class="token keyword">const</span> auto <span class="token operator">&</span><span class="token punctuation">[</span>key<span class="token punctuation">,</span> value<span class="token punctuation">]</span> <span class="token punctuation">:</span> my_map<span class="token punctuation">)</span> <span class="token punctuation">{</span>
7694
std<span class="token punctuation">:</span><span class="token punctuation">:</span>cout <span class="token operator"><<</span> key <span class="token operator"><<</span> <span class="token string">': '</span> <span class="token operator"><<</span> value <span class="token operator"><<</span> <span class="token string">', '</span><span class="token punctuation">;</span>
7795
<span class="token punctuation">}</span>
78-
std<span class="token punctuation">:</span><span class="token punctuation">:</span>cout <span class="token operator"><<</span> <span class="token string">'\n'</span><span class="token punctuation">;</span></code></pre><pre><code class="language-v">doc1 <span class="token operator">:=</span> toml<span class="token punctuation">.</span><span class="token function">parse_text</span><span class="token punctuation">(</span><span class="token operator"><</span><span class="token builtin">string</span> content<span class="token operator">></span><span class="token punctuation">)</span> <span class="token keyword">or</span> <span class="token punctuation">{</span> <span class="token function">panic</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span> <span class="token punctuation">}</span>
79-
doc2 <span class="token operator">:=</span> toml<span class="token punctuation">.</span><span class="token function">parse_file</span><span class="token punctuation">(</span><span class="token operator"><</span>file path<span class="token operator">></span><span class="token punctuation">)</span> <span class="token keyword">or</span> <span class="token punctuation">{</span> <span class="token function">panic</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span> <span class="token punctuation">}</span></code></pre><h3>Escape html in strings</h3><pre><code class="language-v"><span class="token keyword">const</span> html <span class="token operator">=</span> <span class="token string">'&lt;!DOCTYPE html&gt;
96+
std<span class="token punctuation">:</span><span class="token punctuation">:</span>cout <span class="token operator"><<</span> <span class="token string">'\n'</span><span class="token punctuation">;</span></code></pre>
97+
<pre><code class="language-v">doc1 <span class="token operator">:=</span> toml<span class="token punctuation">.</span><span class="token function">parse_text</span><span class="token punctuation">(</span><span class="token operator"><</span><span class="token builtin">string</span> content<span class="token operator">></span><span class="token punctuation">)</span> <span class="token keyword">or</span> <span class="token punctuation">{</span> <span class="token function">panic</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span> <span class="token punctuation">}</span>
98+
doc2 <span class="token operator">:=</span> toml<span class="token punctuation">.</span><span class="token function">parse_file</span><span class="token punctuation">(</span><span class="token operator"><</span>file path<span class="token operator">></span><span class="token punctuation">)</span> <span class="token keyword">or</span> <span class="token punctuation">{</span> <span class="token function">panic</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span> <span class="token punctuation">}</span></code></pre>
99+
<h3 id="escape-html-in-strings">Escape html in strings</h3>
100+
<pre><code class="language-v"><span class="token keyword">const</span> html <span class="token operator">=</span> <span class="token string">'&lt;!DOCTYPE html&gt;
80101
&lt;html lang=&#34;en&#34;&gt;
81102
&lt;head&gt;
82103
&lt;style&gt;
@@ -99,20 +120,33 @@ <h2>Description</h2><p>This is an example of a an .md file, used for adding more
99120
console.log(res);
100121
}
101122
&lt;/script&gt;
102-
&lt;/html&gt;'</span></code></pre><ul><li>Regular markdown list point 1</li><li>List point 2</li><li>List point 3</li></ul><ol><li>Numbered markdown list point 1</li><li>List point 2</li><li>List point 3</li></ol><p>A code block without a specific language should be rendered verbatim:</p><pre><code>.
123+
&lt;/html&gt;'</span></code></pre>
124+
<ul>
125+
<li>Regular markdown list point 1</li>
126+
<li>List point 2</li>
127+
<li>List point 3</li></ul>
128+
<ol>
129+
<li>Numbered markdown list point 1</li>
130+
<li>List point 2</li>
131+
<li>List point 3</li></ol>
132+
<p>A code block without a specific language should be rendered verbatim:</p>
133+
<pre><code>.
103134
├── static/
104135
│ ├── css/
105136
│ │ └── main.css
106137
│ └── js/
107138
│ └── main.js
108139
└── main.v
109-
</code></pre><p>The s tags here in the code block, should be rendered verbatim, not interpreted as HTML ones:</p><pre><code>h:m:s // 5:02:33
140+
</code></pre>
141+
<p>The s tags here in the code block, should be rendered verbatim, not interpreted as HTML ones:</p>
142+
<pre><code>h:m:s // 5:02:33
110143
m:s.mi&lt;s&gt; // 2:33.015
111144
s.mi&lt;s&gt; // 33.015s
112145
mi.mc&lt;ms&gt; // 15.007ms
113146
mc.ns&lt;ns&gt; // 7.234us
114147
ns&lt;ns&gt; // 234ns
115-
</code></pre><p>The End.</p>
148+
</code></pre>
149+
<p>The End.</p>
116150

117151
</section>
118152

0 commit comments

Comments
 (0)