api.template.html 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. {% extends "base.template.html" %}
  2. {% block content %}
  3. <!-- todo: pass version number of a release to the gulp>dgeni>nunjucks pipeline and make available as 'git.version' -->
  4. <!--<a href='https://github.com/{$ git.info.owner $}/{$ git.info.repo $}/tree/{$ git.version.isSnapshot and 'master' or git.version.raw $}/{$ doc.fileInfo.projectRelativePath $}#L{$ doc.startingLine $}' class='view-source pull-right btn btn-primary'>
  5. <i class="glyphicon glyphicon-zoom-in">&nbsp;</i>View Source
  6. </a>-->
  7. {% block header %}
  8. <header class="api-profile-header">
  9. <h1 class="api-profile-header-heading">{$ doc.name $}</h1>
  10. </header>
  11. {% endblock %}
  12. {% block description %}
  13. <div class="api-profile-description">
  14. {$ doc.description | marked $}
  15. </div>
  16. {% endblock %}
  17. {% if doc.deprecated %}
  18. <fieldset class="deprecated">
  19. <legend>Deprecated API</legend>
  20. {$ doc.deprecated| marked $}
  21. </fieldset>
  22. {% endif %}
  23. <div>
  24. {% block dependencies %}
  25. {%- if doc.requires %}
  26. <h2 id="dependencies">Dependencies</h2>
  27. <ul>
  28. {% for require in doc.requires %}<li>{$ require | link $}</li>{% endfor %}
  29. </ul>
  30. {% endif -%}
  31. {% endblock %}
  32. {% block additional %}
  33. {% endblock %}
  34. {% block examples %}
  35. {%- if doc.examples %}
  36. <h2 id="example">Example</h2>
  37. {%- for example in doc.examples -%}
  38. {$ example | marked $}
  39. {%- endfor -%}
  40. {% endif -%}
  41. {% endblock %}
  42. </div>
  43. {% endblock %}