From b4c2e09df1a38750e9682b34bd419e440a8364d0 Mon Sep 17 00:00:00 2001 From: Austen Adler Date: Tue, 14 Mar 2023 00:23:14 -0400 Subject: [PATCH] Start work on embedding docs --- build.earth | 2 +- docs/ALGORITHM.adoc | 2 +- docs/DESIGN.adoc | 4 +-- docs/index.adoc | 6 ++-- justfile | 6 ++-- web-frontend/.gitignore | 4 +-- web-frontend/.prettierignore | 2 ++ web-frontend/src/routes/+layout.svelte | 5 ++- web-frontend/src/routes/docs/+page.svelte | 9 +++++ web-frontend/src/routes/docs/[slug]/+page.js | 33 +++++++++++++++++++ .../src/routes/docs/[slug]/+page.svelte | 5 +++ 11 files changed, 63 insertions(+), 15 deletions(-) create mode 100644 web-frontend/src/routes/docs/+page.svelte create mode 100644 web-frontend/src/routes/docs/[slug]/+page.js create mode 100644 web-frontend/src/routes/docs/[slug]/+page.svelte diff --git a/build.earth b/build.earth index 097cc6a..1ff47a7 100644 --- a/build.earth +++ b/build.earth @@ -17,7 +17,7 @@ docs-build: COPY ./README.adoc docs/index.adoc COPY --dir ./docs . - RUN asciidoctor -r asciidoctor-mathematical -- ./docs/*.adoc + RUN asciidoctor -r asciidoctor-mathematical --embedded -- ./docs/*.adoc RUN \ find docs -type f -not -iname '*.html' -not -iname '*.png' -not -iname '*.svg' -delete && \ : diff --git a/docs/ALGORITHM.adoc b/docs/ALGORITHM.adoc index e9001da..d5766d3 100644 --- a/docs/ALGORITHM.adoc +++ b/docs/ALGORITHM.adoc @@ -7,7 +7,7 @@ include::common.adoc.template[] The goal of this document is to define the algorithm. -If you want to see the steps to get to this definition, go to link:/docs/DESIGN.html[DESIGN]. +If you want to see the steps to get to this definition, go to link:design[DESIGN]. == Data format diff --git a/docs/DESIGN.adoc b/docs/DESIGN.adoc index 886fe12..7e7af00 100644 --- a/docs/DESIGN.adoc +++ b/docs/DESIGN.adoc @@ -8,7 +8,7 @@ include::common.adoc.template[] The goal of this document is to walk through how the design was chosen. -If you want to see the algorithm definition, go to link:/docs/ALGORITHM.html[ALGORITHM]. +If you want to see the algorithm definition, go to link:algorithm[ALGORITHM]. == 10,000 meter view @@ -559,7 +559,7 @@ image::./annotated_wordlist_example.png[Screenshot of docs/annotated_words.ods a ==== Wordlist generation The final wordlist can be generated by running the scripts in `./wordlist/`, which brings together the full list of words, nltk lemmatized words, and manual annotated words into one list. -See link:WORDLIST.html[WORDLIST] for more information +See link:wordlist[WORDLIST] for more information The output is of the format: diff --git a/docs/index.adoc b/docs/index.adoc index 1ffc552..2fa7d82 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -6,9 +6,9 @@ include::common.adoc.template[] == Pages -* link:/docs/ALGORITHM.html[ALGORITHM] - Algorithm definition -* link:/docs/DESIGN.html[DESIGN] - Algorithm design documentation -* link:/docs/WORDLIST.html[WORDLIST] - Wordlist design and implementation +* link:algorithm[ALGORITHM] - Algorithm definition +* link:design[DESIGN] - Algorithm design documentation +* link:wordlist[WORDLIST] - Wordlist design and implementation ++++