Skip to content

fix(tools): use markdown headings on docspages #2516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bennypowers merged 4 commits into from
Jun 15, 2023
Merged

fix(tools): use markdown headings on docspages #2516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1ab91b
fix(tools): use markdown headings on docspages
bennypowers Jun 8, 2023
18ddc10
Merge branch 'main' into tools/docspage-md-headings
bennypowers Jun 13, 2023
bd9e938
Merge branch 'main' into tools/docspage-md-headings
bennypowers Jun 13, 2023
498bad1
Merge branch 'main' into tools/docspage-md-headings
zeroedin Jun 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tools/pfe-tools/11ty/DocsPage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ export class DocsPage implements DocsPageRenderer {
this.templates.addFilter('log', DocsPage.#log);
this.templates.addFilter('type', DocsPage.#type);
this.templates.addFilter('innerMD', DocsPage.#innerMD);
this.templates.addFilter('mdHeading', (header, length = 2) =>
DocsPage.#innerMD(`${Array.from({ length }, () => '#').join('')} ${header}`));
this.templates.addFilter('stringifyParams', DocsPage.#stringifyParams);
this.docsTemplatePath = options?.docsTemplatePath;
}
Expand Down
6 changes: 2 additions & 4 deletions tools/pfe-tools/11ty/templates/attributes.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{% set header = header or 'Attributes' %}

<section class="band api attributes api-properties">
<h{{level}}>{{ header | innerMD | safe }}</h{{level}}> {% if not content and not attributes.length %}
{{ header | mdHeading(level) | safe }} {% if not content and not attributes.length %}

<em>None</em> {%- else -%}

Expand All @@ -20,9 +20,7 @@
</dl> {%- endif -%} {%- if deprecated.length -%}

<details>
<summary>
<h{{level+1}}>{{ ('Deprecated ' + header) | innerMD | safe }}</h{{level+1}}>
</summary>
<summary>{{ ('Deprecated ' + header) | mdHeading(level + 1) | safe }}</summary>
<dl> {%- for attribute in deprecated -%}
<dt><strong><code>{{ attribute.name }}</code></strong></dt>
<dd>
Expand Down
2 changes: 1 addition & 1 deletion tools/pfe-tools/11ty/templates/band.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% set level = level or 2 %}

<section class="band">
<h{{level}}>{{ header | innerMD | safe }}</h{{level}}>
{{ header | mdHeading(level) | safe }}
{{ content | innerMD | safe }}
</section>
6 changes: 2 additions & 4 deletions tools/pfe-tools/11ty/templates/css-custom-properties.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

<section class="api band css-custom-properties api-properties">
<a id="styling-hooks"></a>
<h{{level}}>{{ header | innerMD | safe }}</h{{level}}> {% if not content and not cssProperties.length %}
{{ header | mdHeading(level) | safe }} {% if not content and not cssProperties.length %}

<em>None</em> {%- else -%}

Expand All @@ -37,9 +37,7 @@
</table> {%- endif -%} {%- if deprecated.length -%}

<details>
<summary>
<h{{level+1}}>{{ ('Deprecated ' + header) | innerMD | safe }}</h{{level+1}}>
</summary>
<summary>{{ ('Deprecated ' + header) | mdHeading(level + 1) | safe }}</summary>
<table>
<thead>
<tr>
Expand Down
6 changes: 2 additions & 4 deletions tools/pfe-tools/11ty/templates/css-shadow-parts.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{% set header = header or 'CSS Shadow Parts' %}

<section class="api band css-shadow-parts api-properties">
<h{{level}}>{{ header | innerMD | safe }}</h{{level}}> {% if not content and not parts.length %}
{{ header | mdHeading(level) | safe }} {% if not content and not parts.length %}

<em>None</em> {%- else -%}

Expand All @@ -14,9 +14,7 @@
</dl> {%- endif -%} {%- if deprecated.length -%}

<details>
<summary>
<h{{level+1}}>{{ ('Deprecated '+header) | innerMD | safe }}</h{{level+1}}>
</summary>
<summary>{{ ('Deprecated ' + header) | mdHeading(level + 1) | safe }}</summary>
<dl> {% for part in deprecated -%}
<dt><strong><code>{{ part.name }}</code></strong></dt>
<dd>
Expand Down
6 changes: 2 additions & 4 deletions tools/pfe-tools/11ty/templates/events.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{% set header = header or 'Events' %}

<section class="api band events api-properties">
<h{{level}}>{{ header | innerMD | safe }}</h{{level}}> {% if not content and not events.length %}
{{ header | mdHeading(level) | safe }} {% if not content and not events.length %}

<em>None</em> {% else %}

Expand All @@ -18,9 +18,7 @@
</dl> {%- endif -%} {%- if deprecated.length -%}

<details>
<summary>
<h{{level+1}}>{{ ('Deprecated ' + header) | innerMD | safe }}</h{{level+1}}>
</summary>
<summary>{{ ('Deprecated ' + header) | mdHeading(level + 1) | safe }}</summary>
<dl> {%- for event in deprecated -%}
<dt><strong><code>{{ event.name }}</code></strong></dt>
<dd>
Expand Down
6 changes: 2 additions & 4 deletions tools/pfe-tools/11ty/templates/methods.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{# TODO: inline code highlighting for type and default: render the markdown to html and extract the `<code>` from the `<pre>` #}

<section class="api band methods api-properties">
<h{{level}}>{{ header | innerMD | safe }}</h{{level}}> {% if not content and not methods.length %}
{{ header | mdHeading(level) | safe }} {% if not content and not events.length %}

<em>None</em> {% else %}

Expand All @@ -15,9 +15,7 @@
</dl> {%- endif -%} {%- if deprecated.length -%}

<details>
<summary>
<h{{level+1}}>{{ ('Deprecated '+header) | innerMD | safe }}</h{{level+1}}>
</summary>
<summary>{{ ('Deprecated ' + header) | mdHeading(level + 1) | safe }}</summary>
<dl> {%- for method in deprecated -%}
<dt><strong><code>{{ method.name }}({{ method | stringifyParams }})</code></strong></dt>
<dd>
Expand Down
6 changes: 4 additions & 2 deletions tools/pfe-tools/11ty/templates/overview.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<section class="band overview">
<h2>Overview</h2>

## Overview

<div class="example-preview">
{{ content | safe }}
Expand All @@ -8,7 +9,8 @@
</section>

<section class="band">
<h2>Installation</h2>

## Installation

```shell
npm install {{ package.name }}
Expand Down
6 changes: 2 additions & 4 deletions tools/pfe-tools/11ty/templates/properties.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{# TODO: inline code highlighting for type and default: render the markdown to html and extract the `<code>` from the `<pre>` #}

<section class="api band properties api-properties">
<h{{level}}>{{ header | innerMD | safe }}</h{{level}}> {% if not content and not properties.length %}
{{ header | mdHeading(level) | safe }} {% if not content and not properties.length %}

<em>None</em> {% else %}

Expand All @@ -22,9 +22,7 @@
</dl> {% endif %} {%- if deprecated.length -%}

<details>
<summary>
<h{{level+1}}>{{ ('Deprecated ' + header) | innerMD | safe }}</h{{level+1}}>
</summary>
<summary>{{ ('Deprecated ' + header) | mdHeading(level + 1) | safe }}</summary>
<dl> {%- for property in deprecated -%}
<dt><strong><code>{{ property.name }}</code></strong></dt>
<dd>
Expand Down
6 changes: 2 additions & 4 deletions tools/pfe-tools/11ty/templates/slots.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{% set header = header or 'Slots' %}

<section class="api band slots api-properties">
<h{{level}}>{{ header | innerMD | safe }}</h{{level}}> {% if not content and not slots.length %}
{{ header | mdHeading(level) | safe }} {% if not content and not slots.length %}

<em>None</em> {%- else -%}

Expand All @@ -17,9 +17,7 @@
</dl> {%- endif -%} {%- if deprecated.length -%}

<details>
<summary>
<h{{level+1}}>{{ ('Deprecated ' + header) | innerMD | safe }}</h{{level+1}}>
</summary>
<summary>{{ ('Deprecated ' + header) | mdHeading(level + 1) | safe }}</summary>
<dl> {% for slot in deprecated -%}
<dt> {%- if slot.name -%}
<strong><code>{{ slot.name }}</code></strong> {%- else -%}
Expand Down