docs: fix links from TOC to Headings and improve appearance of docs (a little) (#4866)

* docs: fix links from TOC to Headings
* docs: Styling

Just a little modernisation of the appearance of the documentation

* Update src/bin/doc/package.json

Co-authored-by: Richard Hansen <rhansen@rhansen.org>

Co-authored-by: Richard Hansen <rhansen@rhansen.org>

doc/assets/style.css

@@ -1,62 +1,35 @@
-html {
+body{
-  border-top: solid green 5pt;
+  border-top: solid #44b492 5pt;
-}
+  line-height:150%;
-
+  font-family: 'Quicksand',sans-serif;
-body.apidoc {
+  color: #313b4a;
-  width: 60%;
+  max-width:800px;
-  min-width: 10cm;
   margin: 0 auto;
+  padding: 20px;
 }
 
-#header {
+a{
-  padding: 1pc 0;
+  color: #555;
-  color: #111;
 }
 
-a,
+h1{
-a:active {
+  color: #44b492;
-  color: #272;
+  line-height:100%;
-}
-a:focus,
-a:hover {
-  color: #050;
 }
 
-#apicontent a.mark,
+a:hover{
-#apicontent a.mark:active {
+  color: #44b492;
-  float: right;
-  color: #BBB;
-  font-size: 0.7cm;
-  text-decoration: none;
-}
-#apicontent a.mark:focus,
-#apicontent a.mark:hover {
-  color: #AAA;
 }
 
-#apicontent code {
+pre{
-  padding: 1px;
+  background-color: #e0e0e0;
-  background-color: #EEE;
+  padding:20px;
-  border-radius: 4px;
-  border: 1px solid #DDD;
-}
-#apicontent pre>code {
-  display: block;
-  overflow: auto;
-  padding: 5px;
 }
 
-table, th, td {
+code{
-  text-align: left;
+  background-color: #e0e0e0;
-  border: 1px solid gray;
-  border-collapse: collapse;
 }
 
-th {
+img {
-  padding: 0.5em;
+  max-width: 100%;
-  background: #EEE;
-}
-
-td {
-  padding: 0.5em;
 }

src/bin/doc/html.js

@@ -137,6 +137,12 @@ const getSection = (lexed) => {
 const buildToc = (lexed, filename, cb) => {
   let toc = [];
   let depth = 0;
+
+  marked.setOptions({
+    headerIds: true,
+    headerPrefix: `${filename}_`,
+  });
+
   lexed.forEach((tok) => {
     if (tok.type !== 'heading') return;
     if (tok.depth - depth > 1) {

src/bin/doc/package-lock.json

@@ -1,13 +0,0 @@
-{
-  "name": "node-doc-generator",
-  "version": "0.0.0",
-  "lockfileVersion": 1,
-  "requires": true,
-  "dependencies": {
-    "marked": {
-      "version": "1.1.1",
-      "resolved": "https://registry.npmjs.org/marked/-/marked-1.1.1.tgz",
-      "integrity": "sha512-mJzT8D2yPxoPh7h0UXkB+dBj4FykPJ2OIfxAWeIHrvoHDkFxukV/29QxoFQoPM6RLEwhIFdJpmKBlqVM3s2ZIw=="
-    }
-  }
-}

src/bin/doc/package.json

@@ -7,7 +7,7 @@
     "node": ">=10.17.0"
   },
   "dependencies": {
-    "marked": "1.1.1"
+    "marked": "^2.0.0"
   },
   "devDependencies": {},
   "optionalDependencies": {},