refactor: keep lists content synchronized

ipfs · Mar 30, 2023 · 26a941c · 26a941c
1 parent e6df2ae
commit 26a941c
Show file tree

Hide file tree

Showing 12 changed files with 65 additions and 126 deletions.
diff --git a/src/_includes/footer.html b/src/_includes/footer.html
@@ -13,4 +13,4 @@
   </div>
 </footer>
 </body>
-</html>
+</html>
diff --git a/src/_includes/head.html b/src/_includes/head.html
@@ -9,4 +9,4 @@
   <link rel="stylesheet" href="/css/ipseity.min.css">
   <link rel="icon" href="/img/ipfs-standards.svg">
 </head>
-<body>
+<body>
diff --git a/src/_includes/specs/http-gateways/http.html b/src/_includes/specs/http-gateways/http.html
@@ -0,0 +1,14 @@
+<dl>
+  <dt><a href="/http-gateways/path-gateway/">Path Gateways</a></dt>
+  <dd>
+    The most versatile form of IPFS Gateway is a Path Gateway. It exposes namespaces like <code>/ipfs/</code> and
+    <code>/ipns/</code> under an HTTP server root and provides basic primitives for integrating IPFS resources
+    within the existing HTTP stack.
+  </dd>
+  <dt><a href="/http-gateways/trustless-gateway/">Trustless Gateways</a></dt>
+  <dd>
+    Trustless Gateways are a minimal <em>subset</em> of <a href="/http-gateways/path-gateway/">Path Gateways</a>
+    that allow light IPFS clients to retrieve data behind a CID and verify its integrity without delegating any
+    trust to the gateway itself.
+  </dd>
+</dl>
diff --git a/src/_includes/specs/http-gateways/web.html b/src/_includes/specs/http-gateways/web.html
@@ -0,0 +1,19 @@
+<dl>
+  <dt><a href="/http-gateways/dnslink-gateway/">DNSLink Gateways</a></dt>
+  <dd>
+    DNSLink Gateways are an extension of <a href="/http-gateways/path-gateway/">Path Gateways</a> that enable hosting a
+    specific content path under a specific DNS name.
+  </dd>
+  <dt><a href="/http-gateways/subdomain-gateway/">Subdomain Gateways</a></dt>
+  <dd>
+    Subdomain Gateways are an extension of <a href="/http-gateways/path-gateway/">Path Gateways</a> that
+    enable website hosting isolated per CID/name, while remaining compatible with web browsers relative pathing and
+    the security model of the web.
+  </dd>
+  <dt><a href="/http-gateways/web-redirects-file/">Redirects File</a></dt>
+  <dd>
+    The Redirects File specification is an extension of the Subdomain Gateway and DNSLink Gateway specifications that
+    enables URL redirects or rewrites by adding redirect rules to a0 file stored underneath the root CID of a web
+    site.
+  </dd>
+</dl>
diff --git a/src/_includes/specs/ipns.html b/src/_includes/specs/ipns.html
@@ -0,0 +1,11 @@
+<dl>
+  <dt><a href="/ipns/ipns-record/">IPNS Record and Protocol</a></dt>
+  <dd>
+    Specifies the IPNS protocol in a language-agnostic manner, allowing everyone to create a compatible IPNS Record Publisher
+    or Resolver.
+  </dd>
+  <dt><a href="/ipns/ipns-pubsub-router/">IPNS PubSub Router</a></dt>
+  <dd>
+    Specifies how to publish and retrieve IPNS records using libp2p PubSub router.
+  </dd>
+</dl>
diff --git a/src/_includes/specs/meta.html b/src/_includes/specs/meta.html
@@ -0,0 +1,11 @@
+<dl>
+  <dt><a href="/meta/code-of-conduct/">Code of Conduct</a></dt>
+  <dd>
+    The code of conduct that all community participants are held to.
+  </dd>
+  <dt><a href="/meta/spec-for-specs/">Spec for Specs</a></dt>
+  <dd>
+    Specifies the format and system used to create and maintain specifications for
+    the interplanetary stack.
+  </dd>
+</dl>
diff --git a/src/css/index.css b/src/css/index.css
@@ -1,4 +1,3 @@
-
 body {
   margin: 0;
   padding: 0;

diff --git a/src/css/specs.css b/src/css/specs.css
@@ -1,5 +1,3 @@
-
-
 :root {
   --size-mono: 0.9em;
 }

diff --git a/src/http-gateways/index.html b/src/http-gateways/index.html
@@ -12,44 +12,13 @@ <h3>HTTP</h3>
   <p>
     Low-level gateways that expose IPFS resources over HTTP protocol.
   </p>
-  <dl>
-    <dt><a href="/http-gateways/path-gateway/">Path Gateways</a></dt>
-    <dd>
-      The most versatile form of IPFS Gateway is a Path Gateway. It exposes namespaces like <code>/ipfs/</code> and
-      <code>/ipns/</code> under an HTTP server root and provides basic primitives for integrating IPFS resources
-      within the existing HTTP stack.
-    </dd>
-    <dt><a href="/http-gateways/trustless-gateway/">Trustless Gateways</a></dt>
-    <dd>
-      Trustless Gateways are a minimal <em>subset</em> of <a href="/http-gateways/path-gateway/">Path Gateways</a>
-      that allow light IPFS clients to retrieve data behind a CID and verify its integrity without delegating any
-      trust to the gateway itself.
-    </dd>
-  </dl>
+  {% include 'specs/http-gateways/http.html' %}
   <h3>Web</h3>
   <p>
     Designed for website hosting and improved interoperability with web browsers and
     <a href="https://en.wikipedia.org/wiki/Same-origin_policy">origin-based security model</a>.
   </p>
-  <dl>
-    <dt><a href="/http-gateways/dnslink-gateway/">DNSLink Gateways</a></dt>
-    <dd>
-      DNSLink Gateways are an extension of <a href="/http-gateways/path-gateway/">Path Gateways</a> that enable hosting a
-      specific content path under a specific DNS name.
-    </dd>
-    <dt><a href="/http-gateways/subdomain-gateway/">Subdomain Gateways</a></dt>
-    <dd>
-      Subdomain Gateways are an extension of <a href="/http-gateways/path-gateway/">Path Gateways</a> that
-      enable website hosting isolated per CID/name, while remaining compatible with web browsers relative pathing and
-      the security model of the web.
-    </dd>
-    <dt><a href="/http-gateways/web-redirects-file/">Redirects File</a></dt>
-    <dd>
-      The Redirects File specification is an extension of the Subdomain Gateway and DNSLink Gateway specifications that
-      enables URL redirects or rewrites by adding redirect rules to a0 file stored underneath the root CID of a web
-      site.
-    </dd>
-  </dl>
+  {% include 'specs/http-gateways/web.html' %}
 </main>
 
 {% include 'footer.html' %}
diff --git a/src/index.html b/src/index.html
@@ -56,7 +56,6 @@ <h3>An open governance model</h3>
     </div>
   </div>
   -->
-
   <section>
     <h2>Specifications</h2>
     <p>
@@ -69,56 +68,15 @@ <h3><a href="/http-gateways/">HTTP Gateways</a></h3>
           IPFS Gateway acts as a bridge between traditional HTTP clients and IPFS. Through the gateway, users can download files,
           directories and other IPLD data stored in IPFS as if they were stored in a traditional web server.
         </p>
-        <dl>
-          <dt><a href="/http-gateways/path-gateway/">Path Gateways</a></dt>
-          <dd>
-            The most versatile form of IPFS Gateway is a Path Gateway. It exposes namespaces like <code>/ipfs/</code> and
-            <code>/ipns/</code> under an HTTP server root and provides basic primitives for integrating IPFS resources
-            within the existing HTTP stack.
-          </dd>
-          <dt><a href="/http-gateways/trustless-gateway/">Trustless Gateways</a></dt>
-          <dd>
-            Trustless Gateways are a minimal <em>subset</em> of <a href="/http-gateways/path-gateway/">Path Gateways</a>
-            that allow light IPFS clients to retrieve data behind a CID and verify its integrity without delegating any
-            trust to the gateway itself.
-          </dd>
-          <dt><a href="/http-gateways/dnslink-gateway/">DNSLink Gateways</a></dt>
-          <dd>
-            DNSLink Gateways are an extension of <a href="/http-gateways/path-gateway/">Path Gateways</a> that enable hosting a
-            specific content path under a specific DNS name.
-          </dd>
-          <dt><a href="/http-gateways/subdomain-gateway/">Subdomain Gateways</a></dt>
-          <dd>
-            Subdomain Gateways are an extension of <a href="/http-gateways/path-gateway/">Path Gateways</a> that
-            enable website hosting isolated per CID/name, while remaining compatible with web browsers relative pathing and
-            the security model of the web.
-          </dd>
-          <dt><a href="/http-gateways/web-redirects-file/">Redirects File</a></dt>
-          <dd>
-            The Redirects File specification is an extension of the Subdomain Gateway and DNSLink Gateway specifications that
-            enables URL redirects or rewrites by adding redirect rules to a0 file stored underneath the root CID of a web
-            site.
-          </dd>
-        </dl>
+        {% include 'specs/http-gateways/http.html' %}
+        {% include 'specs/http-gateways/web.html' %}
       </section>
       <section>
         <h3><a href="/ipns/">InterPlanetary Naming System</a></h3>
         <p>
           The InterPlanetary Naming System (IPNS) is a naming system responsible for creating, reading and updating mutable pointers to data.
         </p>
-
-        <dl>
-          <dt><a href="/ipns/ipns-record/">IPNS Record and Protocol</a></dt>
-          <dd>
-            Specifies the IPNS protocol in a language-agnostic manner, allowing everyone to create a compatible IPNS Record Publisher
-            or Resolver.
-          </dd>
-          <dt><a href="/ipns/ipns-pubsub-router/">IPNS PubSub Router</a></dt>
-          <dd>
-            Specifies how to publish and retrieve IPNS records using libp2p PubSub router.
-          </dd>
-        </dl>
-
+        {% include 'specs/ipns.html' %}
       </section>
       <section>
         <h3><a href="/meta/">Meta</a></h3>
@@ -127,27 +85,7 @@ <h3><a href="/meta/">Meta</a></h3>
           project work: what the core values are, what the governance model is, how to produce documents,
           etc.
         </p>
-        <dl>
-          <dt><a href="/meta/code-of-conduct/">Code of Conduct</a></dt>
-          <dd>
-            The code of conduct that all community participants are held to.
-          </dd>
-          <dt><a href="/meta/spec-for-specs/">Spec for Specs</a></dt>
-          <dd>
-            Specifies the format and system used to create and maintain specifications for
-            the interplanetary stack.
-          </dd>
-          <!-- <dt><a href="/meta/license/">Document License</a></dt>
-          <dt>Document License</dt>
-          <dd>
-            tk
-              WHATWG:
-              Copyright © WHATWG (Apple, Google, Mozilla, Microsoft). This work is licensed under a Creative Commons Attribution 4.0 International License. To the extent portions of it are incorporated into source code, such portions in the source code are licensed under the BSD 3-Clause License instead.
-              W3C:
-              Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang). W3C liability, trademark and permissive document license rules apply.
-          </dd>
-              -->
-        </dl>
+        {% include 'specs/meta.html' %}
       </section>
     </div>
   </section>

diff --git a/src/ipns/index.html b/src/ipns/index.html
@@ -7,17 +7,7 @@
 {% include 'header.html' %}
 
 <main>
-  <dl>
-    <dt><a href="/ipns/ipns-record/">IPNS Record and Protocol</a></dt>
-    <dd>
-      Specifies the IPNS protocol in a language-agnostic manner, allowing everyone to create a compatible IPNS Record Publisher
-      or Resolver.
-    </dd>
-    <dt><a href="/ipns/ipns-pubsub-router/">IPNS PubSub Router</a></dt>
-    <dd>
-      Specifies how to publish and retrieve IPNS records using libp2p PubSub router.
-    </dd>
-  </dl>
+  {% include 'specs/ipns.html' %}
 </main>
 
 {% include 'footer.html' %}
diff --git a/src/meta/index.html b/src/meta/index.html
@@ -9,17 +9,7 @@
 {% include 'header.html' %}
 
 <main>
-  <dl>
-    <dt><a href="/meta/code-of-conduct/">Code of Conduct</a></dt>
-    <dd>
-      The code of conduct that all community participants are held to.
-    </dd>
-    <dt><a href="/meta/spec-for-specs/">Spec for Specs</a></dt>
-    <dd>
-      Specifies the format and system used to create and maintain specifications for
-      the interplanetary stack.
-    </dd>
-  </dl>
+  {% include 'specs/meta.html' %}
 </main>
 
 {% include 'footer.html' %}
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,4 +13,4 @@ @@
       </div>
     </footer>
     </body>
-    </html>
+    </html>