eslint/docs/src/_includes/layouts/doc.html

   1 ---
   2 layout: base.html
   3 ---
   4
   5 {% include "partials/docs-header.html" %}
   6 {% from 'components/rule-categories.macro.html' import ruleCategories %}
   7
   8 <div class="docs-wrapper">
   9     <div class="docs-nav">
  10         <div class="desktop-only">
  11             {% include 'components/version-switcher.html' %}
  12         </div>
  13             {% include 'components/docs-index.html' %}
  14     </div>
  15
  16     {# Add in various sections to content so TOC is accurate #}
  17     {% set all_content = content %}
  18     {% set rule_meta = rules_meta[title] %}
  19     {% set added_version = rule_versions.added[title] %}
  20     {% set removed_version = rule_versions.removed[title] %}
  21
  22     {% if related_rules %}
  23         {% set related_rules_content %}
  24             <h2 id="related-rules">Related Rules</h2>
  25             {% related_rules related_rules %}
  26         {% endset %}
  27
  28         {% set all_content = [all_content, related_rules_content] | join %}
  29     {% endif %}
  30
  31     {% if added_version %}
  32         {% set version_content %}
  33             <h2 id="version">Version</h2>
  34             <p>This rule was introduced in ESLint v{{added_version}}{% if removed_version%}
  35                  and removed in v{{removed_version}}{% endif %}.</p>
  36         {% endset %}
  37
  38         {% set all_content = [all_content, version_content] | join %}
  39     {% endif %}
  40
  41     {% if further_reading %}
  42         {% set further_reading_content %}
  43             <h2 id="further-reading">Further Reading</h2>
  44             {% for url in further_reading %}
  45                 {% link url %}
  46             {% endfor %}
  47         {% endset %}
  48
  49         {% set all_content = [all_content, further_reading_content] | join %}
  50     {% endif %}
  51
  52     {% if rule_meta %}
  53         {% set resources_content %}
  54             <h2 id="resources">Resources</h2>
  55             <ul>
  56                 <li><a href="https://github.com/eslint/eslint/blob/main/lib/rules/{{ title }}.js">Rule source</a></li>
  57                 <li><a href="https://github.com/eslint/eslint/blob/main/tests/lib/rules/{{ title }}.js">Tests source</a></li>
  58             </ul>
  59         {% endset %}
  60         {% set all_content = [all_content, resources_content] | join %}
  61     {% endif %}
  62
  63     <div class="docs-content">
  64         <main id="main" tabindex="-1" class="docs-main">
  65             <div class="docs-main__content">
  66                 <h1>{{ title }}</h1>
  67                 {% if rule_meta %}
  68                     {%set id = true if (rule_meta.docs.recommended or rule_meta.fixable or rule_meta.hasSuggestions) else false %}
  69                     <p>{{ rule_meta.docs.description | markdown | safe }}</p>
  70                     {{ ruleCategories({
  71                     index: id,
  72                     recommended: rule_meta.docs.recommended,
  73                     fixable: rule_meta.fixable,
  74                     hasSuggestions: rule_meta.hasSuggestions
  75                     }) }}
  76                 {% endif %}
  77
  78                 {% include 'components/docs-toc.html' %}
  79
  80                 {{ all_content | safe }}
  81             </div>
  82
  83             <div class="docs-edit-link">
  84                 <a href="
  85                 {% if edit_link %}
  86                     {{ edit_link }}
  87                 {% else %}
  88                     {{ site.edit_link.start_with }}{{ page.inputPath }}
  89                 {% endif %}
  90                 "
  91                 class="c-btn c-btn--secondary">{{ site.edit_link.text }}</a>
  92             </div>
  93         </main>
  94
  95         <div class="docs-aside">
  96             <div class="docs-aside__content">
  97                 <aside class="docs-ad">
  98                     {%- include 'partials/carbon-ad.html' -%}
  99                 </aside>
 100                 {% include 'components/docs-toc.html' %}
 101             </div>
 102             {% include "partials/docs-footer.html" %}
 103         </div>
 104     </div>
 105 </div>
 106
 107 <script src="{{ '/assets/js/tabs.js' | url }}"></script>