cleanup scripts + plugins, switch to psyche for search

Author: dragonwocky

Diff for: .vscode/launch.json

@@ -4,7 +4,7 @@
     {
       "request": "launch",
       "type": "pwa-node",
-      "program": "https:/deno.land/x/lume@v1.4.2/cli.ts",
+      "program": "lume/cli.ts",
       "cwd": "${workspaceFolder}",
       "runtimeExecutable": "deno",
       "runtimeArgs": [
@@ -20,7 +20,7 @@
     {
       "request": "launch",
       "type": "pwa-node",
-      "program": "https:/deno.land/x/lume@v1.4.2/cli.ts",
+      "program": "lume/cli.ts",
       "cwd": "${workspaceFolder}",
       "runtimeExecutable": "deno",
       "runtimeArgs": [

Diff for: .vscode/lume_import_map.json

@@ -1,7 +1,7 @@
 {
   "imports": {
-    "lume": "https:/deno.land/x/[email protected].2/mod.ts",
-    "lume/": "https:/deno.land/x/[email protected].2/",
-    "https://deno.land/x/lume/": "https:/deno.land/x/[email protected].2/"
+    "lume": "https:/deno.land/x/[email protected].3/mod.ts",
+    "lume/": "https:/deno.land/x/[email protected].3/",
+    "https://deno.land/x/lume/": "https:/deno.land/x/[email protected].3/"
   }
 }

Diff for: .vscode/settings.json

@@ -6,4 +6,4 @@
     "https://deno.land": true
   },
   "deno.importMap": ".vscode/lume_import_map.json"
-}
+}

Diff for: _config.ts

@@ -1,24 +1,24 @@
-import lume from "https:/deno.land/x/lume@v1.4.2/mod.ts";
+import lume from "lume";
 
-import resolveUrls from "https:/deno.land/x/[email protected]/plugins/resolve_urls.ts";
-import codeHighlight from "https:/deno.land/x/[email protected]/plugins/code_highlight.ts";
+import resolveUrls from "lume/plugins/resolve_urls.ts";
+import codeHighlight from "lume/plugins/code_highlight.ts";
+import bundler from "lume/plugins/bundler.ts";
+import postcss from "lume/plugins/postcss.ts";
 
-import bundler from "https:/deno.land/x/[email protected]/plugins/bundler.ts";
-import esbuild from "https://raw.githubusercontent.com/lumeland/experimental-plugins/ad1d4d27ff435197cdb753183447849c7f518ea3/esbuild/esbuild.ts";
-import minify from "https://raw.githubusercontent.com/lumeland/experimental-plugins/ad1d4d27ff435197cdb753183447849c7f518ea3/minify/minify.ts";
-
-import windicss from "https://raw.githubusercontent.com/lumeland/experimental-plugins/ad1d4d27ff435197cdb753183447849c7f518ea3/windicss/windicss.ts";
-import postcss from "https://deno.land/x/[email protected]/plugins/postcss.ts";
+import psyche from "https://deno.land/x/[email protected]/indexers/lume.ts";
 import featherIcons from "https://cdn.skypack.dev/feather-icons";
 
+import esbuild from "https://raw.githubusercontent.com/lumeland/experimental-plugins/cb94abee21c241ad0b34fc872b3c5985caa0e0a8/esbuild/esbuild.ts";
+import minify from "https://raw.githubusercontent.com/lumeland/experimental-plugins/cb94abee21c241ad0b34fc872b3c5985caa0e0a8/minify/minify.ts";
+import windicss from "https://raw.githubusercontent.com/lumeland/experimental-plugins/cb94abee21c241ad0b34fc872b3c5985caa0e0a8/windicss/windicss.ts";
+
 import windiConfig from "./_windi.config.ts";
-import codeLanguage from "./_plugins/code_language.ts";
-import tableOfContentsPlugin from "./_plugins/table_of_contents.ts";
-import searchIndexer from "./_plugins/search_indexer.ts";
+import codeLabels from "./_plugins/code_labels.ts";
+import tableOfContents from "./_plugins/table_of_contents.ts";
 
 export const site = lume({}, {
   nunjucks: { includes: "_layouts" },
-  markdown: { plugins: [codeLanguage], keepDefaultPlugins: true },
+  markdown: { plugins: [codeLabels], keepDefaultPlugins: true },
 });
 
 site.ignore("README.md");
@@ -27,21 +27,28 @@ site.copy("media", "media");
 site.copy("assets", "assets");
 site.loadAssets([".ts"]);
 
-site.use(tableOfContentsPlugin());
-site.use(searchIndexer());
+// used for "edit this page" links
+site.preprocess([".html"], (page) => {
+  page.data.filename = page.src.path + page.src.ext;
+});
 
+// icons
 const feather = (value: string, attrs = {}) =>
   featherIcons.icons[value].toSvg(attrs);
 site.filter("feather", feather);
+
+// content
+site.use(tableOfContents());
 site.use(codeHighlight());
+site.use(psyche());
 
+// assets
 site.use(windicss({
   minify: true,
   config: windiConfig,
   windiLangFiles: "merge",
 }));
 site.use(postcss());
-
 site.use(resolveUrls());
 site.use(bundler());
 site.use(esbuild());

Diff for: _data.yml

@@ -2,6 +2,10 @@ site_icon: /media/animated.gif
 site_favicon: /media/colour-x32.png
 site_embed: /media/colour-x512.png
 
+site_banner: false
+site_banner_icon: ✨
+site_banner_message: notion-enhancer v0.11.0 is now available. Happy new year!
+
 site_root: https://notion-enhancer.github.io
 site_name: notion-enhancer
 site_description: an enhancer/customiser for the all-in-one productivity workspace notion.so
@@ -26,33 +30,39 @@ nav:
     icon: coffee
     url: https://github.com/sponsors/dragonwocky
 
-action_buttons:
+sidebar:
+  - getting-started
+  - advanced
+  - about
+  - documentation
+  - tools
+
+landing_actions:
+  - action: open-search
+    icon: search
+    tooltip: Search
+  - action: toggle-theme
+    icon: moon
+    tooltip: Toggle theme
+
+header_actions:
+  - action: open-search
+    icon: search
+    tooltip: Search
+  - action: toggle-theme
+    icon: moon
+    tooltip: Toggle theme
+
+corner_actions:
   - action: toggle-menu
     icon: menu
     tooltip: Toggle menu
-    sm_only: true
-    sm_class: md:(pointer-events-none opacity-0)
+    breakpoint: md
   - action: open-search
     icon: search
     tooltip: Search
-    sm_only: false
-    sm_class: sm:(pointer-events-none opacity-0)
+    breakpoint: sm
   - action: toggle-theme
     icon: moon
     tooltip: Toggle theme
-    sm_only: false
-    sm_class: sm:(pointer-events-none opacity-0)
-
-hotkeys:
-  - keys: ctrl/⌘ + k
-    text: to search
-  - keys: arrows ↑ ↓
-    text: to navigate
-  - keys: enter ↵
-    text: to select
-  - keys: /
-    text: to focus
-  - keys: esc
-    text: to close
-  - keys: ctrl/⌘ + shift + l
-    text: to toggle theme
+    breakpoint: sm

Diff for: _layouts/base.njk

@@ -31,25 +31,13 @@
 
   <body class="min-h-full w-full flex flex-col font-sans bg-body h-full">
 
-    <div class="flex items-center bg-purple-500 text-white text-sm font-bold px-4 py-3" role="alert">
-      {# {{ 'alert-triangle' | feather({ class: "w-4 h-4 mr-4 flex-shrink-0" }) | safe }} #}
-      <p><span class="mr-1.5">✨</span> notion-enhancer v0.11.0 is now available. Happy new year!</p>
-    </div>
+    {% if site_banner %}
+    <figure class="flex items-center bg-purple-500 text-white text-sm font-bold px-4 py-3" role="banner">
+      <figcaption><span class="mr-1.5">{{ site_banner_icon }}</span> {{ site_banner_message }}</figcaption>
+    </figure>
+    {% endif %}
 
     {{ content | safe }}
 
-    <div class="fixed bottom-4 right-4 z-9 flex flex-col">
-      {% for btn in action_buttons %}
-      <button data-action="{{ btn.action }}" class="button-floating group {{ btn.sm_class }}">
-        <span class="tooltip opacity-0 group-hover:opacity-100 right-10 bottom-0">
-          {{ btn.tooltip }}
-        </span>
-        {{ btn.icon | feather | safe }}
-      </button>
-      {% endfor %}
-    </div>
-
-    {% include "search.njk" %}
-
   </body>
 </html>

Diff for: _layouts/docs.njk

@@ -1,12 +1,5 @@
 ---
 layout: base.njk
-
-sidebar:
-  - getting-started
-  - advanced
-  - about
-  - documentation
-  - tools
 ---
 
 <header class="bg-header border-b-1 border-dim flex justify-center <sm:(pb-4 pt-4.5) sm:py-6">
@@ -16,15 +9,15 @@ sidebar:
   ">
     <a href="/" class="flex-shrink-0 grid w-max max-w-full pr-2 flex items-center">
       <div class="col-span-1 row-span-2 w-18 mr-4">
-        <img src="{{ site_icon }}" class="h-18 w-full">
+        <img src="{{ site_icon }}" class="h-18 w-full" alt="">
       </div>
       <h1 class="col-start-2 mt-auto font-mono font-bold text-lg">{{ site_name }}</h1>
       <p class="col-start-2 mb-auto text-xs max-w-56">{{ site_description }}</p>
     </a>
     <nav class="sm:ml-auto" aria-label="links">
       <ul class="flex flex-row flex-wrap sm:(items-center h-full justify-end) <sm:mt-4">
-        {% for btn in action_buttons %}
-        {% if btn.sm_only !== true %}
+
+        {% for btn in header_actions %}
         <li class="<sm:hidden p-1 group relative flex justify-center">
           <button data-action="{{ btn.action }}" class="button !bg-opacity-0 !hover:bg-opacity-50 sm:text-sm">
             {{ btn.icon | feather | safe }}
@@ -33,8 +26,8 @@ sidebar:
             {{ btn.tooltip }}
           </span>
         </li>
-        {% endif %}
         {% endfor %}
+        
         {% for btn in nav %}
         <li class="<sm:(p-0.5 flex-grow text-center) sm:p-1">
           <a href="{{ btn.url }}" class="button <sm:(text-xs py-2 px-3 justify-center) sm:text-sm">
@@ -43,6 +36,7 @@ sidebar:
           </a>
         </li>
         {% endfor %}
+
       </ul>
     </nav>
   </div>
@@ -64,11 +58,11 @@ sidebar:
         {% for page in search.pages(section, "order title") %}
           <li>
           {% if page.data.url == url %}
-            <a aria-current="page" aria-description="{{ page.data.description }}" href="{{ page.data.url }}" 
+            <a aria-current="page" href="{{ page.data.url }}" 
               class="border-l border-primary pl-3 py-1 text-sm text-primary"
             >{{ page.data.title }}</a>
           {% else %}
-            <a aria-description="{{ page.data.description }}" href="{{ page.data.url }}" class="
+            <a href="{{ page.data.url }}" class="
               border-l border-dim pl-3 py-1 text-sm transition duration-200
               text-dim hover:text-primary
             ">{{ page.data.title }}</a>
@@ -136,3 +130,14 @@ sidebar:
   </aside>
 
 </main>
+
+<div class="fixed bottom-4 right-4 z-9 flex flex-col">
+  {% for btn in corner_actions %}
+  <button data-action="{{ btn.action }}" class="button-floating group {{ btn.breakpoint }}:(pointer-events-none opacity-0)">
+    <span class="tooltip opacity-0 group-hover:opacity-100 right-10 bottom-0">
+      {{ btn.tooltip }}
+    </span>
+    {{ btn.icon | feather | safe }}
+  </button>
+  {% endfor %}
+</div>

Diff for: _layouts/search.njk

@@ -1,15 +1,15 @@
 /**
  * notion-enhancer
- * (c) 2021 dragonwocky <[email protected]> (https://dragonwocky.me/)
+ * (c) 2022 dragonwocky <[email protected]> (https://dragonwocky.me/)
  * (https://notion-enhancer.github.io/) under the MIT license
  */
 
-import MarkdownIt from "https://cdn.skypack.dev/markdown-it?dts";
+import type MarkdownIt from "https://cdn.skypack.dev/markdown-it?dts";
 
 // invisible within pages, shows up in search index
-const colon = '<span style="display:none">:</span>';
+const colon = '<span style="display:none">: </span>';
 
-// displays language or additional meta e.g. filename
+// displays language or other meta e.g. filename
 // at the top of code blocks
 export default (md: MarkdownIt) => {
   const fence = md.renderer.rules.fence!;
@@ -20,12 +20,10 @@ export default (md: MarkdownIt) => {
       language = info.length ? info.shift() : "",
       meta = info.join(" ");
     token.info = language;
-    const html = fence(...args);
+    const html = fence(...args),
+      label = `<div>${meta || language}${colon}</div>`;
     return meta || language
-      ? html.replace(
-        /^<pre>/,
-        `<pre data-has-meta><div>${meta || language}${colon}</div>`,
-      )
+      ? html.replace(/^<pre>/, `<pre data-labelled>${label}`)
       : html;
   };
 };

Diff for: _plugins/code_language.ts renamed to _plugins/code_labels.ts

@@ -68,7 +68,7 @@ const index = jsDoc.map((namespace) => {
 }).sort((a, b) => a.namespace.localeCompare(b.namespace));
 
 await Deno.writeTextFile(
-  `${__dirname}/../documentation/_data.json`,
+  `${__dirname}/../../documentation/_data.json`,
   JSON.stringify({
     section: "Developer Documentation",
     section_order: 4,