Templates (#3949)
* Update page-templates.md * Update page-templates.md * Update page-templates.md * Update page-templates.md * Update page-templates.md * Update page-templates.md * Update page-templates.md * Update page-templates.mdpull/3859/merge
parent
8604566e8b
commit
ab310e21cd
|
@ -26,7 +26,7 @@ to conceptual topics that provide related background and knowledge.</p>
|
|||
|
||||
<p>To write a new task page, create a Markdown file in a subdirectory of the
|
||||
/docs/tasks directory. In your Markdown file, provide values for these
|
||||
variables, and then include templates/task.md:</p>
|
||||
variables:</p>
|
||||
|
||||
<ul>
|
||||
<li>overview - required</li>
|
||||
|
@ -36,6 +36,11 @@ variables, and then include templates/task.md:</p>
|
|||
<li>whatsnext - optional</li>
|
||||
</ul>
|
||||
|
||||
Then include templates/task.md like this:
|
||||
|
||||
{% raw %}<pre>...
|
||||
{% include templates/task.md %}</pre>{% endraw %}
|
||||
|
||||
<p>In the <code>steps</code> section, use <code>##</code> to start with a level-two heading. For subheadings,
|
||||
use <code>###</code> and <code>####</code> as needed. Similarly, if you choose to have a <code>discussion</code> section,
|
||||
start the section with a level-two heading.</p>
|
||||
|
@ -74,8 +79,7 @@ Here's an interesting thing to know about the steps you just did.
|
|||
* See this [related task](...).
|
||||
{% endcapture %}
|
||||
|
||||
{% include templates/task.md %}
|
||||
</pre>
|
||||
{% include templates/task.md %}</pre>
|
||||
{% endraw %}
|
||||
|
||||
<p>Here's an example of a published topic that uses the task template:</p>
|
||||
|
@ -93,7 +97,7 @@ for deep explanations.
|
|||
|
||||
<p>To write a new tutorial page, create a Markdown file in a subdirectory of the
|
||||
/docs/tutorials directory. In your Markdown file, provide values for these
|
||||
variables, and then include templates/tutorial.md:</p>
|
||||
variables:</p>
|
||||
|
||||
<ul>
|
||||
<li>overview - required</li>
|
||||
|
@ -104,6 +108,11 @@ variables, and then include templates/tutorial.md:</p>
|
|||
<li>whatsnext - optional</li>
|
||||
</ul>
|
||||
|
||||
Then include templates/tutorial.md like this:
|
||||
|
||||
{% raw %}<pre>...
|
||||
{% include templates/tutorial.md %}</pre>{% endraw %}
|
||||
|
||||
<p>In the <code>lessoncontent</code> section, use <code>##</code> to start with a level-two heading. For subheadings,
|
||||
use <code>###</code> and <code>####</code> as needed.
|
||||
|
||||
|
@ -154,8 +163,7 @@ Here's something interesting about the code you ran in the preceding steps.
|
|||
* See this [related tutorial](...).
|
||||
{% endcapture %}
|
||||
|
||||
{% include templates/tutorial.md %}
|
||||
</pre>
|
||||
{% include templates/tutorial.md %}</pre>
|
||||
{% endraw %}
|
||||
|
||||
<p>Here's an example of a published topic that uses the tutorial template:</p>
|
||||
|
@ -172,7 +180,7 @@ tutorials.
|
|||
|
||||
<p>To write a new concept page, create a Markdown file in a subdirectory of the
|
||||
/docs/concepts directory. In your Markdown file, provide values for these
|
||||
variables, and then include templates/concept.md:</p>
|
||||
variables:</p>
|
||||
|
||||
<ul>
|
||||
<li>overview - required</li>
|
||||
|
@ -180,6 +188,11 @@ variables, and then include templates/concept.md:</p>
|
|||
<li>whatsnext - optional</li>
|
||||
</ul>
|
||||
|
||||
Then include templates/concept.md like this:
|
||||
|
||||
{% raw %}<pre>...
|
||||
{% include templates/concept.md %}</pre>{% endraw %}
|
||||
|
||||
<p>In the <code>body</code> section, use <code>##</code> to start with a level-two heading. For subheadings,
|
||||
use <code>###</code> and <code>####</code> as needed.
|
||||
|
||||
|
@ -209,8 +222,7 @@ To use ...
|
|||
* See this [related task](...).
|
||||
{% endcapture %}
|
||||
|
||||
{% include templates/concept.md %}
|
||||
</pre>
|
||||
{% include templates/concept.md %}</pre>
|
||||
{% endraw %}
|
||||
|
||||
<p>Here's an example of a published topic that uses the concept template:</p>
|
||||
|
|
Loading…
Reference in New Issue