more docs and website update, build change

Author: cadebrown

.gitignore

@@ -64,6 +64,8 @@ configure-check.wasm
 *.log
 
 
+# keep the actual PDF copy
+!docs/kscript.pdf
 
 emsdk/
 

README.md

@@ -156,7 +156,13 @@ $ ./bin/ks examples/fib.ks 10
 Inside the `docs/` folder, you can run:
 
 ```shell
-$ pandoc DOCS.md -s --toc --toc-depth 4 --template template.html --lua-filter=pandoc/anchors.lua -o index.html --syntax-highlighting=none
+$ pandoc DOCS.md -o index.html --template template.html -s --toc --number-sections --lua-filter=pandoc/anchors.lua --syntax-highlighting=none
+```
+
+And, to generate a PDF copy:
+
+```shell
+$ pandoc DOCS.md -o kscript.pdf -s --toc --number-sections --pdf-engine=xelatex -V geometry:a4paper -V geometry:margin=2cm -V fontsize=12pt
 ```
 
 ## TODO for final release

configure

@@ -1180,19 +1180,16 @@ echo "\$(ks_BIN): \$(ks_O) \$(libks_SHARED)" >> $T
 echo "	@mkdir -p \$(dir \$@)" >> $T
 
 echo "	\$(CC) \\" >> $T
-#echo "		\$(LDFLAGS) -Wl,-rpath,'@loader_path/../lib' -L./lib -lks -o \$@" >> $T
 echo "		\$(LDFLAGS) \\" >> $T
 
 if [ "$PLATFORM" = "linux" ]; then
     # on Linux, use rpath origin semantics
-    echo "		-Wl,-rpath,'\$\$ORIGIN' -Wl,-rpath,'\$\$ORIGIN/../lib -L./lib -lks' \\" >> $T
+    echo "		-Wl,-rpath,'\$\$ORIGIN' -Wl,-rpath,'\$\$ORIGIN/../lib' -L./lib -lks \\" >> $T
 elif [ "$PLATFORM" = "darwin" ]; then
     # macOS needs the install_name
     echo "		-Wl,-rpath,'@loader_path/../lib' -L./lib -lks \\" >> $T
 fi
 
-# echo "		\$(LDFLAGS) -Wl,-rpath,'@loader_path/../lib' -L./lib -lks \\" >> $T
-
 echo "		\$(ks_O) \\" >> $T
 echo "		-o \$@" >> $T
 

docs/DOCS.md

@@ -19,9 +19,6 @@ function DefinitionList(dl)
     -- first, start with just stringifying the content
     local id = pandoc.utils.stringify(term)
 
-    -- convert to lowercase
-    --id = id:lower()
-    
     -- cut it off at the first parenthesis
     id = id:match("^[^\\(]*")
 

docs/index.html

@@ -5,7 +5,7 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width,initial-scale=1.0">
-    <title>kscript REPL</title>
+    <title>kscript v0.3.1 - REPL</title>
 
     <!-- jQuery -->
     <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
@@ -51,20 +51,6 @@
                 ░                                       
 </template>
 
-<template id="greetings2">
-$$\                                     $$\            $$\     
-$$ |                                    \__|           $$ |    
-$$ |  $$\  $$$$$$$\  $$$$$$$\  $$$$$$\  $$\  $$$$$$\ $$$$$$\   
-$$ | $$  |$$  _____|$$  _____|$$  __$$\ $$ |$$  __$$\\_$$  _|  
-$$$$$$  / \$$$$$$\  $$ /      $$ |  \__|$$ |$$ /  $$ | $$ |    
-$$  _$$<   \____$$\ $$ |      $$ |      $$ |$$ |  $$ | $$ |$$\ 
-$$ | \$$\ $$$$$$$  |\$$$$$$$\ $$ |      $$ |$$$$$$$  | \$$$$  |
-\__|  \__|\_______/  \_______|\__|      \__|$$  ____/   \____/ 
-                                            $$ |               
-                                            $$ |               
-                                            \__|               
-</template>
-
 <script>
 var ks = null;
 let hist_cmds = []

docs/kscript.pdf

@@ -38,83 +38,18 @@ nav {
     overflow-x: hidden;
     padding: 0.5em;
     font-size: 0.9rem;
+    background: #ddd;
 }
 
 
 main {
     width: auto;
     margin-left: 350px;
-    padding: 0 2em;
+    padding: 1em 2em;
 }
 
 
-
-/* @media print { */
-
-@media print {
-    nav {
-        display: none;
-    }
-    main {
-        margin: 0;
-        /* margin: 1.5em; */
-    }
-    pre {
-        white-space: pre-wrap;
-    }
-
-    @page {
-        padding: 1em;
-    }
-}
-
-
-nav.asdf {
-    background: #ddd;
-    /* overflow: auto; */
-
-    position: fixed;
-
-    /* height: 100vh; */
-
-    /* height: 100%;
-    position: fixed;
-    z-index: 1;
-    top: 0;
-    left: 0;
-    overflow-x: hidden; */
-
-
-    width: 300px;
-    padding: 0.5em;
-    font-size: 0.85rem;
-
-    /* height: 100vh; */
-
-    /* background: #ddd;
-    font-size: 0.9rem;
-    width: 300px; */
-    /* flex: 0 0 300px; */
-    /* height: 100vh; */
-}
-
-
-
-main.asdf {
-    /* background: #eee; */
-    flex: 1;
-    /* overflow: auto; */
-    /* height: 100vh; */
-    /* overflow-x: hidden; */
-    padding: 0 1em;
-    padding-left: 320px;
-    width: auto;
-    /* margin: 0; */
-    /* padding: 1.0em; */
-}
-
 /* on the first level of TOC in the nav, don't make it a list */
-
 nav > ul  {
     list-style: none;
     /* padding-left: 0; */
@@ -124,18 +59,9 @@ nav > ul  {
     display: block;
 }
 
-/* on the first level of TOC in the nav, don't make it a list */
-nav > ul > li > ul {
-    list-style: none;
-    /* padding-left: 0; */
-    padding: 0;
-    /* padding: 0.5em; */
-    margin: 0;
-    display: block;
-}
 
 /* and, add an hr divider psuedo-element after each top-level list item */
-nav > ul > li > ul > li::after {
+nav > ul > li::after {
     content: "";
     display: block;
     border-bottom: 1px solid #222;
@@ -144,27 +70,20 @@ nav > ul > li > ul > li::after {
 
 
 /* second level, make it use the first-level list style */
-nav ul ul,
-nav ul ol,
-nav ol ul,
-nav ol ol {
+nav ul ul {
     list-style: initial;
     padding-left: 1.6em;
     margin: 0;
 }
 
+
+/* color links, but don't underline them */
 nav a {
     text-decoration: none;
     color: #0f52aa;
 }
 
 
-
-nav li,
-nav li {
-}
-
-
 dt {
     font-family: monospace;
     font-weight: bold;
@@ -211,8 +130,8 @@ pre {
     /* use section symbol */
     content: "§";
 
-
 }
+
 h1:hover > .anchor-link,
 h2:hover > .anchor-link,
 h3:hover > .anchor-link,
@@ -228,6 +147,72 @@ dt:hover > .anchor-link {
     visibility: visible;
 }
 
+
+
+/* for printing to a physical page, we style it differently */
+@media print {
+    /* hide the nav, since it will show up on each page */
+    nav {
+        display: none;
+    }
+
+    /* don't need any margin on the main content */
+    main {
+        margin: 0;
+    }
+
+    /* overflow would be hidden, since there is no scrollbar */
+    pre {
+        white-space: pre-wrap;
+    }
+
+    /* and each actual page should have some padding as well */
+    @page {
+        padding: 1em;
+    }
+}
+
+
+
+
+
+/* Highlight.js Line Numbers Styling */
+
+/* for block of numbers */
+.hljs-ln-numbers {
+    -webkit-touch-callout: none;
+    -webkit-user-select: none;
+    -khtml-user-select: none;
+    -moz-user-select: none;
+    -ms-user-select: none;
+    user-select: none;
+
+    text-align: center;
+    color: #333;
+    border-right: 1px solid #333;
+    vertical-align: top;
+    /* padding-right: 5px; */
+
+    /* your custom style here */
+}
+
+/* for block of code */
+.hljs-ln-code {
+    padding-left: 5px !important;
+}
+
+
+.hljs-ln td {
+    /* padding: 0 !important; */
+}
+
+
+.hljs-ln-n {
+    padding-right: 5px !important;
+    text-align: right !important;
+}
+
+
 /** Code Highlighting **/
 
 pre code.hljs {

docs/pandoc/anchors.lua

@@ -4,7 +4,7 @@
     <meta charset='utf-8'>
     <meta http-equiv='X-UA-Compatible' content='IE=edge'>
     <meta name='viewport' content='width=device-width,initial-scale=1.0'>
-    <title>$title$</title>
+    <title>kscript v0.3.1 - docs</title>
 
 <!-- MathJax -->
     <script>
@@ -22,9 +22,14 @@
     <script src='./site-hljs-kscript.js'></script>
     <script>hljs.highlightAll();</script>
 
+    <script src="//cdn.jsdelivr.net/npm/[email protected]/dist/highlightjs-line-numbers.min.js"></script>
+    <script>hljs.initLineNumbersOnLoad();</script>
+
 <!-- kscript specific assets -->
     <script src='./site.js'></script>
-    <link rel="stylesheet" href="./site.css"> 
+    <link rel="stylesheet" href="./site.css">
+
+
 </head>
 <body>
     <nav class="sidenav">