From 6f94b650f412d46d92bb8d644cdad6bc1af3591d Mon Sep 17 00:00:00 2001 From: scarf Date: Fri, 23 Feb 2024 18:20:11 +0900 Subject: [PATCH] fix: broken docs pages link (#28) * refactor: move `ancestors` to `utils` * fix: use relative URLs * docs: fix tab order --- _config.ts | 2 ++ deno.lock | 2 ++ doc/_includes/base.ts | 7 +++++-- doc/index.page.ts | 1 + doc/main.ts | 2 +- {doc => utils}/ancestors.ts | 0 {doc => utils}/ancestors_test.ts | 0 7 files changed, 11 insertions(+), 3 deletions(-) rename {doc => utils}/ancestors.ts (100%) rename {doc => utils}/ancestors_test.ts (100%) diff --git a/_config.ts b/_config.ts index 66a0981..ede4efc 100644 --- a/_config.ts +++ b/_config.ts @@ -1,5 +1,6 @@ import lume from "lume/mod.ts" import codeHighlight from "lume/plugins/code_highlight.ts" +import relativeUrls from "lume/plugins/relative_urls.ts" import { codeAutoLink } from "./auto_link.ts" const site = lume({ src: "doc", prettyUrls: false }) @@ -9,5 +10,6 @@ site.copy("assets", "assets") site .use(codeHighlight()) .use(codeAutoLink()) + .use(relativeUrls()) export default site diff --git a/deno.lock b/deno.lock index 13714df..aa3a87a 100644 --- a/deno.lock +++ b/deno.lock @@ -855,8 +855,10 @@ "https://deno.land/x/lume@v2.0.3/plugins/code_highlight.ts": "bd4ef987c4fd05c1c585238a490f9f56d48daefd4748b4647219575b8e1d42c0", "https://deno.land/x/lume@v2.0.3/plugins/json.ts": "f6429bbd865e3666ef3385fd205fcc92df02ca2c0f74f20baa5c0798a81e1642", "https://deno.land/x/lume@v2.0.3/plugins/markdown.ts": "7f4f2cff511d81ea39fcea3d3b39dc34c79a952f911398eac919ced25a5e4365", + "https://deno.land/x/lume@v2.0.3/plugins/modify_urls.ts": "f2319fd98d60578fe78f4c197aa5d98785234732bbd2287e78a47d15d4a2b641", "https://deno.land/x/lume@v2.0.3/plugins/modules.ts": "19a66398a5494f506458e48b8443a7c4700b7577e8fcc0818c39b1d0530c8950", "https://deno.land/x/lume@v2.0.3/plugins/paginate.ts": "e86617ec1ad491c86bc4866db41f070a6b393e8c2ac94ed28a51ca309f88477d", + "https://deno.land/x/lume@v2.0.3/plugins/relative_urls.ts": "279e7c54a1dba9945c7ac742360cca386818e990b6b609b2fda3b4ca4792bdac", "https://deno.land/x/lume@v2.0.3/plugins/search.ts": "8ec3a8f082b8ff1532bbe8f8bf76dfaa2d0feab7c2ec5c824d0ccc044c26f640", "https://deno.land/x/lume@v2.0.3/plugins/toml.ts": "60191e1e8fd0922def0b3f0eaad13988217511571a54659481759db4b0ca4f82", "https://deno.land/x/lume@v2.0.3/plugins/url.ts": "3d298886cb16e1110d427d2f257de6c2ae0da3cd7076b6abcbbd41e7536ed094", diff --git a/doc/_includes/base.ts b/doc/_includes/base.ts index 7874ae7..c5059e9 100644 --- a/doc/_includes/base.ts +++ b/doc/_includes/base.ts @@ -9,7 +9,7 @@ export default ( { content, title, search, head }: Lume.Data, {}: Lume.Helpers, ) => { - const nav = search.pages() + const nav = search.pages("category!=index") .map((x) => /*html*/ `${x.title}`).join("\n") return /*html*/ ` @@ -27,7 +27,10 @@ export default (

StackGraph

- +
${content} diff --git a/doc/index.page.ts b/doc/index.page.ts index d27df3b..429aba1 100644 --- a/doc/index.page.ts +++ b/doc/index.page.ts @@ -1,3 +1,4 @@ +export const category = "index" export const title = "StackGraph란" const readme = () => diff --git a/doc/main.ts b/doc/main.ts index 95c873c..f195ec0 100644 --- a/doc/main.ts +++ b/doc/main.ts @@ -7,7 +7,7 @@ import { Project } from "../deps/ts_morph.ts" import { colors, hashRGB } from "../render/colors.ts" import { denoProjectOption } from "../utils/project.ts" -import { ancestors } from "./ancestors.ts" +import { ancestors } from "../utils/ancestors.ts" import { declDepsToGraph, getAllDecls, getDeclDeps } from "../graph/mod.ts" import { encodeVSCodeURI } from "../graph/vscode_uri.ts" diff --git a/doc/ancestors.ts b/utils/ancestors.ts similarity index 100% rename from doc/ancestors.ts rename to utils/ancestors.ts diff --git a/doc/ancestors_test.ts b/utils/ancestors_test.ts similarity index 100% rename from doc/ancestors_test.ts rename to utils/ancestors_test.ts