Skip to content

Commit

Permalink
#20 #19 #18 #12 help for resource templates
Browse files Browse the repository at this point in the history
  • Loading branch information
yn-coder committed Jul 27, 2018
1 parent e9406a6 commit 36f8f7b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions templates/help.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,10 @@ <h2>On-line help for Azure Notebooks</h2>
</li>
</ul>

<h3>How to write the resource</h3>

<p>Each resource help page is a HTML file in <code>template/resource</code> folder. File name should be in the <code>help_page_name.html</code> form. Our Jupyter extension call for help page depend on current Jupyter notebook name with file extension, so for <code>First.ipynb</code> notebook help file should be named as <code>first.ipynb.html</code>.</p>

<p>Cell code and other parameters from extension is sended to server as <code>?cell_code=start_section</code> form, and pulled to html template for rendering with <a href="http://jinja.pocoo.org/">Jinja</a> template engine as dictionary. Any correct Jinga tags is allowed.</p>

{% endblock %}

0 comments on commit 36f8f7b

Please sign in to comment.