#55 add documentation

tbela99 · Sep 23, 2019 · 20c7535 · 20c7535
1 parent ad598ad
commit 20c7535
Show file tree

Hide file tree

Showing 33 changed files with 2,494 additions and 606 deletions.
diff --git a/Docs/dist/index.html b/Docs/dist/index.html
diff --git a/Docs/images/Server-Timing.PNG b/Docs/images/Server-Timing.PNG
diff --git a/Docs/images/background-sync-settings.PNG b/Docs/images/background-sync-settings.PNG
diff --git a/Docs/images/bg-filter.jpg b/Docs/images/bg-filter.jpg
diff --git a/Docs/images/cache-settings.PNG b/Docs/images/cache-settings.PNG
diff --git a/Docs/images/cdn-settings.PNG b/Docs/images/cdn-settings.PNG
diff --git a/Docs/images/content-security-policy-settings.PNG b/Docs/images/content-security-policy-settings.PNG
diff --git a/Docs/images/critical-css-settings.PNG b/Docs/images/critical-css-settings.PNG
diff --git a/Docs/images/css-settings.PNG b/Docs/images/css-settings.PNG
diff --git a/Docs/images/general-settings.PNG b/Docs/images/general-settings.PNG
diff --git a/Docs/images/http-settings.PNG b/Docs/images/http-settings.PNG
diff --git a/Docs/images/images-settings.PNG b/Docs/images/images-settings.PNG
diff --git a/Docs/images/javascript-settings.PNG b/Docs/images/javascript-settings.PNG
diff --git a/Docs/images/network-settings.PNG b/Docs/images/network-settings.PNG
diff --git a/Docs/images/security-settings.PNG b/Docs/images/security-settings.PNG
diff --git a/Docs/images/service-worker-settings.PNG b/Docs/images/service-worker-settings.PNG
diff --git a/Docs/images/web-share-target-settings.PNG b/Docs/images/web-share-target-settings.PNG
diff --git a/Docs/index.md b/Docs/index.md
diff --git a/Docs/src/filter.php b/Docs/src/filter.php
@@ -0,0 +1,39 @@
+#!/usr/bin/env php
+<?php
+#
+# format the side bar
+#
+# TODO: Fix duplicate ids
+
+$input = file_get_contents('php://stdin');
+
+function process($node, $level = 1) {
+
+	$node['class'] = 'nav bd-sidenav nav-level-'.$level;
+
+	foreach($node->xpath('./li/a') as $link) {
+
+		$link['class'] = 'bd-toc-link';
+
+		foreach ($link->xpath('..') as $parent) {
+
+			$parent['class'] = 'bd-toc-item';
+		}
+
+		foreach ($link->xpath('./following-sibling::ul') as $ul) {
+
+			process($ul, $level + 1);
+		}
+	}
+
+	return $node;
+}
+
+// add class to the toc elements
+echo preg_replace_callback('#(<nav class="side-bar"[^>]+>)(.*?)(<\/nav>)#s', function ($matches) {
+
+	$xml = simplexml_load_string('<?xml version="1.0" encoding="utf-8"?>'.	$matches[2]);
+
+	return $matches[1].str_replace('<?xml version="1.0" encoding="utf-8"?>', '', process($xml, 1)->asXML()).$matches[3];
+
+}, $input);