From 447df617e5ed950abc7f81b2e67521874437ca17 Mon Sep 17 00:00:00 2001 From: tinger Date: Wed, 29 May 2024 17:31:07 +0200 Subject: [PATCH] Clean up - Remove old test case - Remove redundant README entry - Rename internal package module to _pkg - Added README entries --- README.md | 4 +++- src/{packages.typ => _pkg.typ} | 0 src/author.typ | 2 +- src/component/table-of-contents.typ | 2 +- src/component/title-page.typ | 2 +- src/example.typ | 2 +- src/lib.typ | 2 +- src/link.typ | 2 +- src/style.typ | 2 +- src/util.typ | 2 +- tests/complete/ref/1.png | Bin 3841 -> 0 bytes 11 files changed, 11 insertions(+), 9 deletions(-) rename src/{packages.typ => _pkg.typ} (100%) delete mode 100644 tests/complete/ref/1.png diff --git a/README.md b/README.md index cdad558..4702941 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@ A template & package for documents targeting the Typst developer community. This - [ ] add examples to the docs - [ ] Functionality - [ ] Port author reading code from unreleased thesis template to here - - [ ] Source forge specific sub links such as `/issues` - [ ] Mantys like building blocks for documentation adjacent purposes +- [ ] API + - [ ] improved higher level API + - [ ] error handling This template is a fork of [mantys](https://github.com/jneug/typst-mantys). diff --git a/src/packages.typ b/src/_pkg.typ similarity index 100% rename from src/packages.typ rename to src/_pkg.typ diff --git a/src/author.typ b/src/author.typ index 09ba072..2bee8ec 100644 --- a/src/author.typ +++ b/src/author.typ @@ -2,7 +2,7 @@ /// /// Can be used to add new or alter existing marks, marks come in the form of /// arbitrary content which is placed as a superscript. -#let marks = state("__mantodea:util:author:marks", ( +#let marks = state("__mantodea:author:marks", ( marks: (:), current-auto: 0, )) diff --git a/src/component/table-of-contents.typ b/src/component/table-of-contents.typ index f953df5..6f16549 100644 --- a/src/component/table-of-contents.typ +++ b/src/component/table-of-contents.typ @@ -1,4 +1,4 @@ -#import "/src/packages.typ" as _pkg +#import "/src/_pkg.typ" #import "/src/theme.typ" as _theme #let _columns = columns diff --git a/src/component/title-page.typ b/src/component/title-page.typ index cbca1a4..7fe45cc 100644 --- a/src/component/title-page.typ +++ b/src/component/title-page.typ @@ -1,4 +1,4 @@ -#import "/src/packages.typ" as _pkg +#import "/src/_pkg.typ" #import "/src/theme.typ" as _theme #let _version = version diff --git a/src/example.typ b/src/example.typ index b3d1fc1..5d23532 100644 --- a/src/example.typ +++ b/src/example.typ @@ -1,4 +1,4 @@ -#import "/src/packages.typ" as _pkg +#import "/src/_pkg.typ" #import "/src/theme.typ" as _theme /// Show a source code frame. diff --git a/src/lib.typ b/src/lib.typ index 8b59394..f8bfff0 100644 --- a/src/lib.typ +++ b/src/lib.typ @@ -1,4 +1,4 @@ -#import "packages.typ" as _pkg +#import "_pkg.typ" #import "author.typ" #import "component.typ" diff --git a/src/link.typ b/src/link.typ index 807f0fa..03218a8 100644 --- a/src/link.typ +++ b/src/link.typ @@ -194,7 +194,7 @@ /// /// The default matchers include GitHub, GitLab and Codeberg as well as a crude /// git-subdomain matcher which returns the top and second level domain. -#let forges = state("__mantodea:util:link:forges", ( +#let forges = state("__mantodea:link:forges", ( GitHub: s => s.contains("github.com"), GitLab: s => s.contains("gitlab.com"), Codeberg: s => s.contains("codeberg.org"), diff --git a/src/style.typ b/src/style.typ index 54372bb..58f7d8c 100644 --- a/src/style.typ +++ b/src/style.typ @@ -1,4 +1,4 @@ -#import "packages.typ" as _pkg +#import "_pkg.typ" #import "theme.typ" as _theme /// The default style applied over the whole document. diff --git a/src/util.typ b/src/util.typ index cd256f9..ce8ba81 100644 --- a/src/util.typ +++ b/src/util.typ @@ -1,4 +1,4 @@ -#import "/src/packages.typ" as _pkg +#import "/src/_pkg.typ" /// Draw an alert box. /// diff --git a/tests/complete/ref/1.png b/tests/complete/ref/1.png deleted file mode 100644 index 3a04d3be4435585b8eac2df3f207491aab414fa8..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3841 zcmeH|_fym97RJ960YeK2L_pyJqI9sJfIt92NFbpFBONbArOAd+1eTzPt`}(`F-j3Z zGz39VF`&|=2c)^ui&7#GDMCU^$in^syR$QQ=KgSf=KbN!dCt5u?`NKQ&s_(kwJ1mq z1OR|2%*N6Q0QkuOAV3h}+wDl|ruhQ^Z@7aU%8JY7?(FPvI2<;cy}iA?wY9amxw)~i zvA({}VzHP^=GxlY>gwu`A3s)BR+g8SmzI_m7Z<;O|IT1A78Vxf=jZ3<=IC_#?Ck8! z%*^!k^wiYUmoHx?CnqN+CdS9d$HvA+Mn;B*hlhrS1_uWR1_nNV{@mBs*W26M)6>)4 z-Tm?7$F8of&dyF6jn>i8(ca$P*4EbA+S=06(%jtK)YSCh!-vMk#)gK5`uh61y1Lrh z+Un}+s;a8W%1SDg`sU4>ii(QYuV24<_3Guzm*wTS}6g$BrF4di1EOs;Y{Lin6k@l9G~w zg2Lg$hYuY(Bqt{)D=T~O;6VrkA|oRsEiEl2C3WDy0ZB7%VO>E+!@>Dk>@> zA|fm-3<81n@82&ZBqS&(C?FuPZ{I$CetteaK3-nl-T1{m7Z?Np5g5$U92GsxXt=T4 z0}>u{C=kk?{l8QIdB-a#b;=+W+I>8r#JQsF>f3brGj<(m52P}QueAb{hXUVU>!a#Hg_%bMweTDA(n zlcm?cuXO?1O!-T4k+t^{vBPW~+J&Q+lsvmk83KzsWT;L*zYXCo6$z9_`aBr#=aeENzMDW#`IC?Amipsf@9uX- zVT*U>SsPv07a)Z7SIPPs@H!`;JJhYhe_bP!xqTg0QyGTDajs$(MJnev*&$I18TW|Dd9Kei(BpdwYW37N`Lj<69sP`$(UXBU>r2;Mi!$ePkgn~K zlNlB1U$QTnfXF#9S8w}f%H+5U-ze)J<(EwM<}fQ)jArsu0qw0vPVkwa$lB5VfSW!k z*bT8kmmj8NX9)_w*5&VD*`*^QWpc^=AC}9dH}C>N4-CMWS-G32?SD%+kaL~j(z6q2 zrE}1D)*4HH8e8m)1mXy`ekeGE8jiQe+!#+bn^y#opx@pKMj7d|yy@TI6yC_<3t59T zOWWGbKo{mt$rmDC&{3#^_6l16%N(DN8C;2KPIb1ntBZuIyVN7c(z_XppUzN#XeD%8 zAR$Z{u%a~3?Grf9odLGnFlj_R$k%R{z;I^Lb>lLGc1|RT6J6ZtJ4x}lbGZ)yduk{x zRNJ)x1t*+AU=j_O8Z)b;QN;{JV3i`j+1M<(sS_b15h2uH^)gDGV}h$9Ar{Z}M{DW_ zzdE<1<+gle_g13^zRJcrlS!Ll5ZtWMU(Ct3}HOgwZT$rj$Q@T7rjO#qmhmAtgFrSi&?R**<21Awx?B+t|{n;(|v0qxb=x;Gn_aKHe_l% zrBXPB5w`BB0&{aeITSfZn;&f?Yqn2kzAG7rw?J@2V$jfPRf&mrmb$zxVxpeAuvT1* zR+W{