Compare commits

..

319 Commits
v3 ... hugo

Author SHA1 Message Date
Jacky Zhao
66dd6bcf2d deprecate quartz v3 2023-08-19 18:49:50 -07:00
Gimbles
bb3877998a Add font fallbacks (#341) 2023-07-07 12:20:18 -07:00
Morgan Patterson
9450278680 Update Dockerfile (#335)
Fix #305
2023-07-07 12:20:03 -07:00
BSD-Yassin
7b1da7a845 i18n: Update fr.toml (#313) 2023-04-27 11:12:56 -07:00
Jacky Zhao
e482fa1097 fix: graph and tooltip sometimes not showing 2023-04-06 15:06:01 -07:00
Mattia Ippoliti
ba7a968881 fix: padding for empty title callouts (#308) 2023-04-01 13:50:08 -07:00
Md Jawad Noor Asif
db27557aa3 fix: search highlight not showing because for trailing slash (#306) 2023-03-30 07:14:06 -04:00
Mike Walton
b7c305e002 adding myself to the showcase (#301) 2023-03-23 00:56:20 -05:00
Daniel Lazaro
74fe4d6813 docs: Update link to callouts documentation (#300) 2023-03-18 09:20:56 -07:00
Jacky Zhao
d6c31595b3 deps: bump hugo-obsidian 2023-03-16 10:33:01 -07:00
Jacky Zhao
aa5ab03d4a docs: update to account for github changes 2023-03-02 09:14:29 -08:00
Jacky Zhao
ecba6071b8 deps: bump hugo-obsidian 2023-02-25 13:04:15 -08:00
Jacky Zhao
983efab94c fix: recent notes partial sorting 2023-02-12 16:46:11 -08:00
Dev Uni
10e41743e5 fix: Bad UI due to head.html (#284) 2023-02-07 08:38:20 -08:00
Simon Späti
bde44fadf2 feat: Adding Twitter and Social image preview including description (#207) 2023-02-07 00:16:15 -08:00
Jacky Zhao
6885651f7b feat: max-width for large screens 2023-02-06 12:58:34 -08:00
Jacky Zhao
7df2bb6f5e fix: fix duplicate link click tracking 2023-02-05 12:01:49 -08:00
Jacky Zhao
11959de11c feat: add more plausible events 2023-02-05 11:34:39 -08:00
Jacky Zhao
a73aca8ed9 feat: switch from GA to Plausible for analytics 2023-02-05 10:39:58 -08:00
Adam Brangenberg
93610e232b feat: Remove leading slash of folders in graph view (#282) 2023-02-01 12:34:18 -08:00
Jacky Zhao
712dab5c8c docs: remove broken links from showcase 2023-01-31 11:00:28 -08:00
Olivér Falvai
77b3907b23 docs: Clarify Obsidian settings (#280) 2023-01-31 10:48:20 -08:00
herrwinfried
8fc63586c4 feat: Added Turkish translation (#275) 2023-01-29 12:14:11 -08:00
Apoorv Khandelwal
24c9777a52 feat: Embedding multimodal assets (#274) 2023-01-21 10:01:05 -08:00
Quadrubo
7a8811a184 added the liveReloadPort as an option for docker (#272) 2023-01-18 08:25:01 -08:00
chaosarium
eb2f6aeca8 Fix callout behaviour inconsistent with Obsidian (closes #168) (#268) 2023-01-09 14:14:11 -08:00
Md Jawad Noor Asif
b78008532f feat: Added Bangla translations (#266) 2023-01-09 14:12:52 -08:00
Md Jawad Noor Asif
c5b103c85f fix: fix unicode broken tags (#261) 2023-01-03 22:10:25 -05:00
Adam Brangenberg
614a6222a1 refactor: General performance/style improvements (#262) 2022-12-29 10:43:41 -05:00
chaosarium
dc43737896 fix edge cases link processing (#258)
Fixes https://github.com/jackyzha0/quartz/issues/176
2022-12-24 12:10:59 -05:00
toof
ea37486309 fix: fix misspelling (#259) 2022-12-24 10:38:49 -05:00
chaosarium
c1b0eafce6 feat: Added simplified Chinese translations (#257) 2022-12-22 10:34:21 -08:00
Jacky Zhao
ce5df837f5 feat: latex in search results 2022-12-03 21:03:12 -08:00
Jacky Zhao
4cd6f7efdf fix: text highlighting 2022-11-30 18:00:12 -08:00
Apoorv Khandelwal
5a7936e23a fix: Replacing "internal-link broken" with link to asset (#232) 2022-11-30 17:41:05 -08:00
Jon Erling Hustadnes
5fd707714f feat: Added Norwegian localization (#242) 2022-11-27 10:55:43 -08:00
Filippo Andrea Sighinolfi
717a13a580 feat: Added italian localization in i18n/it.toml (#239) 2022-11-27 10:55:13 -08:00
Brendan Ang
5f3d430699 feat: add support for mermaid diagrams (#244) 2022-11-27 10:53:52 -08:00
Jacky Zhao
66f3e249fe fix: only run docker publish on main repository 2022-11-23 08:34:19 -08:00
Jacky Zhao
e374e3abd4 fix: jump to search for operand 2022-11-21 23:36:27 -08:00
SafEight
f08a76a738 fix: External links ending in .md don't get trimmed (#236)
Co-authored-by: SAF <saf@saf.saf>
fixes https://github.com/jackyzha0/quartz/issues/229
2022-11-21 13:05:46 -08:00
Morgan Gallant
d80f6946c8 fix: Semantic Search: Use Operand Beta API (#235) 2022-11-21 08:54:45 -08:00
Jacky Zhao
120d104230 update config for search 2022-11-20 15:14:48 -08:00
Jacky Zhao
e9aa6ae9e7 feat: docker docs, semantic search alpha 2022-11-20 15:09:58 -08:00
Apoorv Khandelwal
c12af32a5a feat: Dockerfile and automated container build (#230) 2022-11-20 14:03:53 -08:00
SafEight
de2b6b9a1b feat: Replace == with <mark> (#234)
Co-authored-by: SAF <saf@saf.saf>
2022-11-19 13:17:55 -08:00
Jacky Zhao
7f9f58860d feat: allow enableToc to override default no TOC on a per-page basis 2022-11-19 11:18:57 -08:00
jet457
151b9851d6 docs: add Abhijeet's math-wiki to the showcase (#228) 2022-11-19 11:10:41 -08:00
saucecoat
d56a58044d Added German translation (#223) 2022-10-29 23:08:44 -07:00
Conor
689201bfbd feat: Add French translation (#221) 2022-10-26 09:12:35 -07:00
Jacky Zhao
9b72edcd9c Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-10-25 13:14:13 -07:00
Jacky Zhao
8704edcca2 deps: bump ubuntu version (closes #218) 2022-10-25 13:14:06 -07:00
Evan Cater
0a602eda1b fix euler's identity (#220) 2022-10-24 09:13:35 -07:00
Javier Zaleta Martínez
72571a7588 feat: Add Spanish translation (#217) 2022-10-18 17:25:55 -07:00
Charles Chamberlain
3409a49f15 fix: Apply monospace style to all meta in a popover (#216) 2022-10-16 09:43:43 -07:00
Pavol Komlos
666ffebe90 Decode the heading id from split link (#214) 2022-10-12 08:21:28 -07:00
Seth
8ea1525df4 Add SethMB Work (#203) 2022-10-03 11:45:54 -07:00
Jacky Zhao
dd11d56dd9 Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-09-23 10:17:34 -07:00
Jacky Zhao
cd7e2088d5 feat: hide TOC when no headers (closes #204) 2022-09-23 10:17:28 -07:00
Simon Späti
169ef442b9 Adding reference projects (#196)
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
2022-09-14 10:05:51 -07:00
DongDong Chen
8e3042df49 add my showcase : oldwinterの数字花园 (#192) 2022-09-14 10:05:20 -07:00
Jacky Zhao
2145e92b00 fix: make latex rendering size more simialr to obsidian 2022-09-12 11:08:07 -07:00
Jacky Zhao
e6c7a4e1e2 fix: latex rendering bugs + patch for #195 2022-09-11 18:03:55 -07:00
Nikola Georgiev
ca84da5b31 feat: Hide full path to file in Wikilinks by default (#195) 2022-09-11 17:05:14 -07:00
Jacky Zhao
0d1670adba Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-08-29 14:23:19 -04:00
Jacky Zhao
5c770f965a Update Quartz version in documentation 2022-08-29 14:23:04 -04:00
Andrii Yefremov
ce55eca73b Add Ukrainian translation (#191) 2022-08-29 14:15:18 -04:00
Jacky Zhao
591c4813ec deps: bump hugo-obsidian version 2022-08-28 01:09:52 -04:00
Jacky Zhao
83e7aec3c9 fix: tag list styling 2022-08-24 00:45:08 -04:00
Youssif Shaaban Alsager
25ba1159ad feat: Add internationalization (i18n) support (#182) 2022-08-23 23:32:40 -04:00
Vincent Huang
e38eaa94d6 Popover preview should show relevant heading (#180) 2022-08-20 21:31:06 -04:00
Jacky Zhao
a78926ede5 feat: link previews to page-list (closes #173) 2022-08-11 11:42:16 -07:00
Jacky Zhao
5c76d8dad9 fix: make callout detection case-insensitive (closes #171) 2022-08-05 11:08:52 -07:00
Jacky Zhao
3dcc1f1106 feat: better graph scaling (closes #170) 2022-08-05 11:04:01 -07:00
Jacky Zhao
ff770927fd style: _callouts.scss simplification (#169) 2022-08-04 14:50:24 -07:00
Jacky Zhao
7ffc907907 fix: CJK search (closes #163) 2022-08-03 23:46:55 -07:00
Jacky Zhao
6dd4c64a4c fix: highlights being stripped in non-semantic search mode 2022-08-01 07:59:49 -07:00
Jacky Zhao
8fc6b8e28e docs: update, re-added debounce 2022-07-31 18:21:17 -07:00
Jacky Zhao
b10b23a47b docs: add documentation for Operand Search, remove debounce 2022-07-31 18:02:06 -07:00
Jacky Zhao
23380d0519 fix: title not being selected properly, bump hugo-obsidian for uri fix 2022-07-31 16:55:25 -07:00
Jacky Zhao
dd047305af deps: bump hugo-obsidian to fix bug of writing to non-existent directory during build 2022-07-31 12:33:36 -07:00
Jacky Zhao
54a8fd4a56 deps: bump hugo-obsidian to properly copy linkmap 2022-07-31 12:24:53 -07:00
Jacky Zhao
5ef9aad501 feat: add support for semantic search using operand 2022-07-31 12:16:36 -07:00
Jacky Zhao
14b89105dc refactor: move search utils to util.js 2022-07-31 10:54:23 -07:00
Jacky Zhao
93d039fe7c deps: bump hugo-obsidian version 2022-07-31 10:14:36 -07:00
Jacky Zhao
234c707a93 docs: improve scss structure and admonition styling, update docs 2022-07-30 18:46:19 -07:00
Emile Bangma
728d8529ec Support Admonition callouts (#166) (closes #88) 2022-07-30 17:29:26 -07:00
Jacky Zhao
e142f37e8d Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-07-19 09:03:26 -07:00
Jacky Zhao
d747b19e61 docs: copy edits 2022-07-19 09:03:19 -07:00
Pranav M
1f3da4b829 feat: edit the clipboard button to change border colour on success (#162)
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
2022-07-18 08:45:36 -07:00
Jacky Zhao
e15e39155d fix: give precedence to date created over last modified if defined (#101) 2022-07-15 14:26:31 -07:00
Jacky Zhao
dff5ae0d4d style: improve header anchor styling 2022-07-14 13:09:21 -07:00
Jacky Zhao
b2555ced61 feat: add description section to section/term/taxonomies, fix header margin 2022-07-14 12:02:54 -07:00
Jacky Zhao
7ccff2cf3d fix: styling on page-list for smaller screens 2022-07-14 11:49:47 -07:00
Jacky Zhao
e0b6606d50 fix: make section-li scss more generic 2022-07-14 10:38:34 -07:00
Jacky Zhao
d7a42a2fd7 feat: improve styling for lists, fix anchor offset 2022-07-14 10:30:07 -07:00
Jacky Zhao
422b6cc25b feat: css typography improvements 2022-07-13 23:51:33 -07:00
Jacky Zhao
22c8981bb9 feat: css refactor for easy font change 2022-07-13 23:37:54 -07:00
Jacky Zhao
8b2a82a96a fix: change / to use base url 2022-07-13 22:27:13 -07:00
y1450
81af8c459b fix: remove console log (#159) 2022-07-13 15:02:11 -07:00
Jacky Zhao
ffe22689eb feat: use floating-ui for better popover positioning 2022-07-13 15:01:50 -07:00
Jacky Zhao
c1b8fe1221 feat: restyle search icon 2022-07-13 14:32:32 -07:00
Jacky Zhao
b7a619bbd7 fix: tabsize not being respected 2022-07-12 14:37:10 -07:00
Jacky Zhao
74993d19b7 docs + fix: broken partial and description of enableGitHubEdit 2022-07-05 15:42:57 -07:00
rphla
25a4d3b6e1 Add GitHub "edit" button (#157) 2022-07-05 15:39:29 -07:00
Jacky Zhao
aaf31f419e fix: copy code block logic for non code pages 2022-07-03 11:50:13 -07:00
Geoffrey Garrett
f54df35767 Copy to clipboard feature for code block (#152)
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
2022-07-03 11:42:35 -07:00
Aiden Bai 白宇彤
015ed4cfa2 Fix width: auto for SPA routing (#156) 2022-07-02 19:40:18 -07:00
Jacky Zhao
a8137edf24 fix: adjust weird colours for err highlighting 2022-07-02 17:14:17 -07:00
Jacky Zhao
eda370334a fix: image scaling for md-style links (closes #155) 2022-07-01 11:27:50 -07:00
Geoffrey Garrett
d3e20b8b94 Added optional rendering of code block titles (#148) 2022-07-01 11:03:52 -07:00
Jacky Zhao
8d7a7b712f fix: non-SPA fn defs (closes #154) 2022-07-01 11:03:04 -07:00
Jacky Zhao
0896814959 docs: remove test image from hosting 2022-06-29 17:35:29 -07:00
Jacky Zhao
8b2fba895a feat: image scaling (closes #131) 2022-06-29 17:34:05 -07:00
Jacky Zhao
e884f4927f fix: anchor formatting (closes #141) 2022-06-29 17:17:53 -07:00
Jacky Zhao
2b0482ae4c docs: fix page weight 2022-06-29 17:03:41 -07:00
Jacky Zhao
8a100edeb8 docs: polish and update 2022-06-29 16:57:36 -07:00
Jacky Zhao
200c605142 feat: enable raw html by default (fixes #143) 2022-06-29 16:16:06 -07:00
Jacky Zhao
f2078ee621 fix: prefix images with base url for non-root quartz 2022-06-29 16:15:40 -07:00
Jacky Zhao
916c51c19c Merge pull request #150 from aidenybai/bump-million 2022-06-28 23:21:25 -07:00
Aiden Bai
67a7ba37e8 Bump million to 1.11.3 2022-06-28 21:43:28 -07:00
Jacky Zhao
72941965ab Merge pull request #146 from geoffreygarrett/hugo 2022-06-27 16:27:57 -07:00
Geoffrey Garrett
b732293f65 fix(head.html): Adds robustness to config.yaml favicon definitions
Initially assumed that `href` definitions should have `/...` as their
pattern, and `baseURL` would always end with `/`, however the omission
of `/` as the prefix of the former and suffix of the latter
simultaneously, would result in broken favicon paths. Final comment:
`..///...` is not breaking, which is worst case scenario with this fix.
2022-06-28 01:21:22 +02:00
Geoffrey Garrett
7070a1992a docs(config.md): Fixed multi-favicon examples and general favicon explanation throughout 2022-06-28 01:15:33 +02:00
Geoffrey Garrett
997937af5a docs(config.md): Added short explainer on favicons 2022-06-28 00:45:48 +02:00
Geoffrey Garrett
a334b45b17 docs(content/notes/config.md): Adds documentation for the new favicon support 2022-06-27 22:05:35 +02:00
Geoffrey Garrett
473ea2c66f feat(layouts/partials/head.html): Adds general favicon support with dict and string input format 2022-06-27 22:04:32 +02:00
Jacky Zhao
34b0353797 Merge pull request #140 from DhammaCharts/hugo 2022-06-07 08:43:52 -07:00
DhammaCharts
52a185f73b change enableGlobalGraph to false 2022-06-06 16:49:01 +01:00
DhammaCharts
69c74ca6b5 minor adjustment 2022-06-06 16:48:16 +01:00
DhammaCharts
ab809249c8 Update layouts/partials/head.html
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
2022-06-06 16:42:53 +01:00
DhammaCharts
84c75d0546 Merge branch 'hugo' into hugo 2022-06-06 12:56:47 +01:00
Jacky Zhao
dbd4fb7595 Merge pull request #139 from aidenybai/prerender-latex 2022-06-03 10:59:18 -07:00
DhammaCharts
a275123be2 better font behaviour 2022-06-02 08:35:28 +01:00
DhammaCharts
c88f31c364 change to object destructuring for drawGraph() arguments 2022-06-02 08:16:02 +01:00
DhammaCharts
d261655d96 remove unnecessary ternary 2022-06-02 07:49:09 +01:00
DhammaCharts
c0800a8749 change baseURL back to original 2022-06-02 07:45:44 +01:00
DhammaCharts
ac0dd50c04 uncomment window.Million 2022-06-01 21:30:40 +01:00
DhammaCharts
e809896338 increase scale 2022-06-01 21:22:31 +01:00
DhammaCharts
19606ba63d add www. 2022-06-01 21:19:03 +01:00
DhammaCharts
1e237ef677 change baseURL 2022-06-01 20:15:44 +01:00
DhammaCharts
5a1fbc9374 Improve graph display, options and ability to have a global graph on the home page, local graphs on subpage. 2022-06-01 13:49:27 +01:00
Aiden Bai
a1293f820a Prerender latex 2022-05-29 20:40:44 -07:00
Jacky Zhao
84c6e1efed Merge pull request #138 from aidenybai/add-footer-config 2022-05-28 23:27:54 -07:00
Aiden Bai
8673a7bc3d Add option to toggle footer 2022-05-28 22:52:18 -07:00
Jacky Zhao
775a1b2490 Merge pull request #137 from aidenybai/fix-non-spa-routing 2022-05-27 19:21:05 -07:00
Aiden Bai
006b74ec6f Fix formatting 2022-05-27 18:45:42 -07:00
Aiden Bai
8aba612a00 Fix non-spa fallback 2022-05-27 18:42:01 -07:00
Jacky Zhao
cbc2bea413 Merge pull request #136 from aidenybai/custom-progress-bar-color 2022-05-27 18:32:49 -07:00
Aiden Bai
ae240ff82c Remove redundant CSS rule 2022-05-27 18:31:36 -07:00
Jacky Zhao
ba586adc76 Merge pull request #135 from aidenybai/bump-million 2022-05-27 17:14:55 -07:00
Aiden Bai
159deabfe1 Bump to 1.9.6 2022-05-27 16:14:17 -07:00
Aiden Bai
44984cdaf4 Add support for progress bar 2022-05-27 13:27:13 -07:00
Aiden Bai
683cb53cbd Bump million to 1.9.5 2022-05-27 13:19:19 -07:00
Jacky Zhao
232bd2f016 Merge pull request #134 from aidenybai/add-prefetching-within-graph 2022-05-27 11:01:20 -07:00
Aiden Bai
e0fd9570d7 Bump million to 1.9.4 2022-05-27 09:49:28 -07:00
Aiden Bai
bc32bbeaed Bump milliomn to 1.9.3 2022-05-27 09:02:01 -07:00
Aiden Bai
efb6c7845f Add prefetch to graph 2022-05-27 08:40:00 -07:00
Aiden Bai
bd316d8249 Bump million to 1.9.2 2022-05-27 08:39:44 -07:00
Jacky Zhao
0293c12217 feat: recent posts section/partial 2022-05-23 22:25:13 -07:00
Jacky Zhao
0439c163a0 fix: js not executing if spa disabled 2022-05-20 16:50:56 -04:00
Jacky Zhao
0b6711c218 fix: tag boxes overlapping for content with many tags (closes #130) 2022-05-14 16:47:50 -04:00
Jacky Zhao
ed9a8efd1f fix inline link highlighting, safer latex render 2022-05-05 21:11:23 -04:00
Jacky Zhao
e302f6c423 fix: more generic style to match bad nesting generated by popover interp 2022-05-05 20:35:32 -04:00
Jacky Zhao
b21b27d1d3 fix: clean wikilinks and render latex in popover 2022-05-05 20:30:55 -04:00
Jacky Zhao
364aee36fc fix: merge conf 2022-05-05 01:03:09 -04:00
Jacky Zhao
cea0f3eb74 feat: contextual backlinks (closes #106) 2022-05-05 00:58:50 -04:00
Jacky Zhao
8b855b522a Merge pull request #125 from aidenybai/fix-latex 2022-05-04 11:40:38 -04:00
Aiden Bai
7b3696b877 Remove pnpm debug log 2022-05-04 08:39:25 -07:00
Aiden Bai
b4ff12ca0b Fix latex 2022-05-04 08:10:59 -07:00
Jacky Zhao
b67a389bea Merge pull request #124 from aidenybai/hugo 2022-05-03 13:59:02 -04:00
Aiden Bai
2b5c03c972 Remove redundant URL construction 2022-05-03 10:55:45 -07:00
Aiden Bai
aaed5dc1f1 Support /path root sites 2022-05-03 10:54:39 -07:00
Aiden Bai
1a5d158fce Support active node with other data at end of url 2022-05-03 10:38:41 -07:00
Jacky Zhao
a09974446d Merge pull request #123 from aidenybai/fix-popover 2022-05-03 13:21:32 -04:00
Aiden Bai
9fc71603ba Merge 2022-05-03 10:18:41 -07:00
Aiden Bai
d38f9bec70 Rename API and generalize router API 2022-05-03 10:16:09 -07:00
Aiden Bai
771ebd8031 Merge 2022-05-03 10:07:38 -07:00
Aiden Bai
e4cc625c33 Add future note about init function 2022-05-03 09:34:27 -07:00
Aiden Bai 白宇彤
3789df80e4 Merge branch 'hugo' into fix-popover 2022-05-03 09:33:00 -07:00
Jacky Zhao
037426217c Merge pull request #122 from aidenybai/fix-active-graph-node 2022-05-03 12:29:26 -04:00
Aiden Bai
e646cdb0be Use explicit regex for trailing slash trim 2022-05-03 09:27:25 -07:00
Aiden Bai
8d092a3a4a Remove unnecessary 'url' argument in graph.html 2022-05-03 09:22:51 -07:00
Aiden Bai
32c79a561f Remove unnecessary 'url' argument in graph.html 2022-05-03 09:21:44 -07:00
Aiden Bai
3c660dd9b5 Remove unnecessary 'url' param in drawGraph 2022-05-03 09:20:01 -07:00
Aiden Bai
4cca3c1f2d Peg router version 2022-05-03 09:04:15 -07:00
Aiden Bai
9d3bbd6076 Fix active node on graph 2022-05-03 08:53:18 -07:00
Aiden Bai
9c71f07355 Enable config for testing 2022-05-03 08:48:35 -07:00
Aiden Bai
77485b754d Fix popover 2022-05-03 08:47:42 -07:00
Jacky Zhao
6e6dd4cb0b fix: trim trailing slash when calculating popover 2022-05-03 10:57:20 -04:00
Jacky Zhao
81fe2d2493 Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-05-03 10:44:56 -04:00
Jacky Zhao
24d08d580d cfg: make SPA optional 2022-05-03 10:43:22 -04:00
Jacky Zhao
321e19dc41 Merge pull request #121 from benbohmer/patch-1 2022-05-03 09:48:50 -04:00
Jacky Zhao
12d33619a2 Merge pull request #120 from straightupjac/fix/github-info 2022-05-03 09:47:48 -04:00
benbohmer
97607c3ca5 fix: keep / at end of URL to avoid redirects
Removed strings.TrimRight "/" in line 10 to keep the trailing slash at the end of URLs in regular links. This avoids having every single internal link being a 301 redirect.
2022-05-03 09:10:45 +02:00
straightupjac
4197ad460a fix github info 2022-05-03 01:51:15 -04:00
Jacky Zhao
fc89ff2680 fix: broken semi and graph min-height 2022-05-02 13:00:41 -04:00
Jacky Zhao
e9a33c04b5 fmt: remove semis for good 2022-05-02 12:56:44 -04:00
Jacky Zhao
b0e15e0cbc Merge pull request #118 from aidenybai/add-router 2022-05-02 12:19:26 -04:00
Jacky Zhao
9ba0a4b34f fmt: remove semis :) 2022-05-02 12:14:51 -04:00
Aiden Bai
f1b85fb6d9 Fix clarification comment 2022-05-02 09:10:40 -07:00
Jacky Zhao
66304da027 Merge pull request #119 from aidenybai/add-prettier
Add prettier config
2022-05-02 12:06:57 -04:00
Aiden Bai
40d216759c Expand template 2022-05-02 09:05:02 -07:00
Aiden Bai
5c602ab16f Add clarification comments 2022-05-02 09:04:36 -07:00
Aiden Bai
87144fca21 Use semi: false for prettier config 2022-05-02 08:57:25 -07:00
Aiden Bai
a9523dd39b Add prettier config 2022-05-01 22:08:14 -07:00
Aiden Bai
bcb166c21c Add router 2022-05-01 22:06:33 -07:00
Jacky Zhao
416dc0b85c fix: add update for local hugo-obsidian on make update 2022-04-30 13:13:30 -07:00
Jacky Zhao
b8a660e208 feat: copyable header anchors (fixes #86) 2022-04-30 13:10:12 -07:00
Jacky Zhao
ec86cca97b Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-04-28 15:53:57 -07:00
Jacky Zhao
87b5a7a251 feat: show graph titles on zoom (fixes #92) 2022-04-28 15:49:16 -07:00
Jacky Zhao
c8d390dbc5 fix: always hide popover on mobile (fixes #104) 2022-04-28 13:45:29 -07:00
Jacky Zhao
3c7ece5405 fix: append trailing slash, fixes #111 2022-04-28 10:48:31 -07:00
Jacky Zhao
f7027e7ecd Merge pull request #108 from exu3/patch-1 2022-04-20 09:20:21 -07:00
Ella
0cfd93c57c Fix another typo 2022-04-17 02:11:17 -07:00
Ella
3f8c473678 Fix typo: recomment -> recommend 2022-04-17 01:33:16 -07:00
Jacky Zhao
f05ff5e62d fix: add dropshadow to popover, cleanup animation 2022-04-05 23:19:33 -07:00
Jacky Zhao
12ed9722d8 fix: popover selection wrongly including line breaks 2022-04-05 22:43:11 -07:00
Jacky Zhao
887d4d4f5e deps: bump hugo -> v0.96.0 2022-04-05 21:40:59 -07:00
Jacky Zhao
f9c7cdf928 fix: check for src before attempting to add popover 2022-04-05 20:44:39 -07:00
Jacky Zhao
2d55b6ac2e fix: missing whitespace chomp in link render hook 2022-04-05 18:07:40 -07:00
Jacky Zhao
d5884aedb7 fix: wikilink patch not applying to transformed text like apostrophes 2022-04-05 14:14:19 -07:00
Jacky Zhao
66eaa444a4 fix: wikilink image relURL for images with spaces 2022-04-05 14:08:36 -07:00
Jacky Zhao
0ddc48a452 fix: wikilink-like text in code fences #95, #97 2022-04-05 13:47:24 -07:00
Jacky Zhao
cd19159c53 feat: wikilink img support 2022-04-05 12:47:28 -07:00
Jacky Zhao
7808c66c4d fix: align footer links 2022-04-05 09:41:13 -07:00
Jacky Zhao
a7abc6ab96 docs: make update command and clarify update steps/potential danger 2022-04-05 00:09:56 -07:00
Jacky Zhao
9509a64354 Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-04-05 00:02:48 -07:00
Jacky Zhao
53242b1e57 add update target to Makefile 2022-04-05 00:02:37 -07:00
Jacky Zhao
3ce6944c18 Merge pull request #93 from meleu/patch-3 2022-04-04 23:56:28 -07:00
Jacky Zhao
3cec4fd950 update screenshot 2022-04-04 23:30:28 -07:00
Jacky Zhao
e245505082 feat: hide toc for short notes 2022-04-04 23:25:24 -07:00
Jacky Zhao
fc4b9ded76 Merge pull request #94 from meleu/patch-4 2022-04-04 23:20:43 -07:00
meleu
27c4761fe0 link to home goes to baseURL 2022-04-04 20:15:40 -03:00
meleu
3583265f80 docs: warn about possible lost of customization 2022-04-04 17:30:23 -03:00
Jacky Zhao
3781b67707 Merge pull request #91 from meleu/patch-2 2022-04-04 13:08:42 -07:00
meleu
671fe05312 padding and border-radius matching bottom cards
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
2022-04-04 17:07:43 -03:00
Jacky Zhao
1613511f39 Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-04-04 09:45:05 -07:00
Jacky Zhao
acab488784 re-add obsidian file 2022-04-04 09:44:58 -07:00
meleu
ff91dcd196 Merge branch 'jackyzha0:hugo' into patch-2 2022-04-03 22:14:12 -03:00
meleu
a287d11246 add a collapsible ToC 2022-04-03 22:12:55 -03:00
Jacky Zhao
575288ece9 Merge pull request #88 from meleu/patch-2 2022-04-03 17:57:46 -07:00
Jacky Zhao
25b5ac43dd fix: favicon not showing on non-root domain #89 2022-04-03 17:43:37 -07:00
meleu
1d9c0e4a44 use "enableToc: false" 2022-04-03 16:31:29 -03:00
meleu
e62d512d95 disable ToC if frontmatter has "enableToc: false" 2022-04-03 16:29:10 -03:00
meleu
8f15c5f8c1 disable ToC if enableToc: false 2022-04-03 16:22:32 -03:00
Jacky Zhao
efeaf9b49c Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-04-03 11:44:39 -07:00
Jacky Zhao
91c4e3fb3a fix: multiline code block #87 2022-04-03 11:44:33 -07:00
Jacky Zhao
22f11711b2 Merge pull request #85 from meleu/patch-1
Ah my git was being really weird with cases :')) thank you
2022-04-03 08:17:13 -07:00
meleu
5c3ef884c7 duplicated file 2022-04-03 11:19:21 -03:00
Jacky Zhao
16b177ce66 README update 2022-04-02 21:04:20 -07:00
Jacky Zhao
14c6181d24 bump hugo version v0.82 -> v0.92.2 2022-04-02 20:37:42 -07:00
Jacky Zhao
e6e04c03c4 fix latex misrendering 2022-04-02 20:34:55 -07:00
Jacky Zhao
146e975932 bump hugo obsidian, fix backlinks for subpathed quartz, update homepage 2022-04-02 20:21:16 -07:00
Jacky Zhao
c117e38899 feat: wikilinks implementation 2022-04-02 20:06:31 -07:00
Jacky Zhao
4fd983277e fix: cjk support + demo page 2022-04-02 17:38:39 -07:00
Jacky Zhao
cc86136bcb feat: basic latex support 2022-04-02 17:00:14 -07:00
Jacky Zhao
8e083d4a93 Merge pull request #83 from meleu/patch-2 2022-04-02 14:53:05 -07:00
meleu
03b574b160 cleanup 2022-04-02 18:51:45 -03:00
meleu
a469653f75 separate contact links semantically 2022-04-02 18:50:58 -03:00
Jacky Zhao
c51573efa9 feat: grey out broken links 2022-04-02 13:34:26 -07:00
Jacky Zhao
902d0f2a0f Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-04-02 12:59:47 -07:00
Jacky Zhao
1ddd15afc6 fix: non-unicode character in popover and search #67, #68 2022-04-02 12:59:38 -07:00
meleu
16f8cd7100 separate links with &ZeroWidthSpace; 2022-04-02 13:37:12 -03:00
Jacky Zhao
9c5ecccf25 Merge pull request #82 from meleu/patch-1 2022-04-01 14:17:35 -07:00
meleu
e3cd531c53 fix custom.scss path 2022-04-01 18:13:49 -03:00
Jacky Zhao
3674df48b8 fix pagination styling 2022-04-01 10:13:01 -07:00
Jacky Zhao
9e8c5587e4 Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-03-31 23:16:00 -07:00
Jacky Zhao
6605b13b86 more troubleshooting, backlinks reference private page fix 2022-03-31 23:15:54 -07:00
Jacky Zhao
6edc979896 Merge pull request #71 from siyangsun/patch-1 2022-03-21 09:15:35 -07:00
Siyang
fc43922445 add to showcase and fix link to file 2022-03-20 22:37:05 -07:00
Jacky Zhao
54a68e6e5c patch image 2022-03-18 10:53:39 -07:00
Jacky Zhao
a6ab2f92ef add update 2022-03-16 17:54:24 -07:00
Jacky Zhao
fda481fbb9 fix: bump hugo-obsidian version to account for contentIndex paths on windows 2022-03-15 01:12:08 -07:00
Jacky Zhao
94e987dab5 feat: better titles for empty pages #61 2022-03-15 00:37:56 -07:00
Jacky Zhao
e981c76ed4 Merge pull request #65 from claudio4/fix-text 2022-03-09 10:11:36 -08:00
Claudio Yanes
f70128a3de Prevent overflow of long links and words
When a word (or any string withtout breakpoints (spaces, dashes....), making links the most common place where this becamoes an issue)  is wider than its container, the text will simply overflow any container, including the viewport. This commit fixes this behaviour by making the word-drap strategy of the browser more aggresive.
2022-03-09 17:58:01 +00:00
Jacky Zhao
651bfc5cd2 Merge pull request #62 from claudio4/hugo 2022-03-07 10:45:07 -08:00
Claudio Yanes
6079420178 Merge branch 'jackyzha0-hugo' into hugo 2022-03-07 18:28:14 +00:00
Claudio Yanes
b96c60edfc Merge branch 'hugo' of https://github.com/jackyzha0/quartz into jackyzha0-hugo 2022-03-07 18:27:45 +00:00
Claudio Yanes
978d5ca1ae Format JS 2022-03-07 18:25:02 +00:00
Jacky Zhao
907270992d fix: hide popover on mobile to prevent overflow 2022-03-04 23:55:07 -08:00
Claudio Yanes
6f9283e95b Update makefile and docs
The artifacts produced by hugo-obsidian are now expected to be placed in
the assets/indices directory. This commit reflects this change in the
Makefile and in the docs.
2022-03-04 22:27:21 +00:00
Claudio Yanes
0fad5570d3 Add .gitkeep to assets/indices 2022-03-04 04:14:42 +00:00
Claudio Yanes
dc9b421e21 Remove unnecessary scrollbars
The margin property can escape the parent node and move it alongside
its child. This happens with singlePage div and the body, resulting in
scrollbars appearing as the body has the size of the viewport but
does not align with it. This phenomenon can be always observed
in the vertical axis and it can also be observed in the horizontal axis
when the viewport it’s not wide enough (mostly in mobile).

Using paddings prevents this “extra space” from scraping and displacing
the body.

Also, the value 100vw does not take into account the space taken by the
vertical scrollbar, thus making the body wider than the actual viewport,
producing a horizontal scrollbar.
2022-03-04 04:12:43 +00:00
Claudio Yanes
8779e72c77 Add attribute property to scripts from jsdelivr
Adding the integrity attribute protects the website (by refusing to load
the script) against malicious modifications of the script
in the case of jsdelivr gets hacked
2022-03-04 03:34:45 +00:00
Claudio Yanes
7f6523337c Move popover to the end of the page
The popover script doesn’t ever start in until the DOM has finished
Loading, so wait for the script to be downloaded and parsed before
Showing the content to the user makes no sense.
2022-03-04 03:24:32 +00:00
Claudio Yanes
7e0f2e4449 Fix fetchData
The fetchData function suffer from a race condition. If the function is
called before the promise finishes, it will result in another pair of
HTTP request. This does not only make the function useless but
Actually, it makes it harmful as the data might be redownloaded twice.

Now fetchData is not a function but rather the promise by itself.
Previous callers are expected to await the variable instead, this
should be not concern as awaiting a promise multiple time in
JavaScript is completely safe.
2022-03-04 02:25:30 +00:00
Claudio Yanes
1313bd9779 Move css and js to appropriate files
Having the CSS and JS in the html template produces pages larger
than necessary, as each page need to contain all the js/css.
Separating them in appropriate files allow the browser to just download
them once and use them for all the pages. This is even more effective
with an aggressive cache policy for the js and css, something that can
be done without fear thanks to the implemented cache-busting.
Also, having then in separate files allows us to use Hugo pipelines
for minimizing the code.
2022-03-04 02:07:51 +00:00
Jacky Zhao
5234fae080 fix backlinks not using baseurl 2022-02-28 08:24:29 -08:00
Jacky Zhao
0ee0855e1c bump hugo-obsidian to support root 2022-02-28 07:30:59 -08:00
Jacky Zhao
e06e341468 fix: explicitly set root as current directory to fix ignore files 2022-02-28 07:14:55 -08:00
Jacky Zhao
73e526a7d5 add screenshot to readme 2022-02-23 12:28:25 -05:00
Jacky Zhao
cdc4f1a840 fix: relink search button (move outside content load listener) 2022-02-22 13:36:08 -05:00
Jacky Zhao
714b4fcfa3 fix links being broken for pages with spaces 2022-02-20 21:40:10 -05:00
Jacky Zhao
9c04ca0266 rtl docs 2022-02-17 10:49:41 -05:00
Jacky Zhao
388a2bf78b docs updates 2022-02-17 10:44:39 -05:00
Jacky Zhao
f192f9a23d fix #54: root all image urls 2022-02-15 23:03:02 -05:00
Jacky Zhao
3b3e6ec3b2 fix relative pathing for dynamic fetch 2022-02-15 22:54:20 -05:00
Jacky Zhao
8e85e274f6 change output to static instead of data 2022-02-15 19:42:45 -05:00
Jacky Zhao
fcd5d2807d feat: dynamically fetch indices 2022-02-15 19:39:14 -05:00
Jacky Zhao
4587b13360 feat: add rtl support as part of #47 2022-02-15 17:12:08 -05:00
Jacky Zhao
fb9ea8dcb8 Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-02-15 16:52:49 -05:00
Jacky Zhao
c520db4882 fix: #50, change css load order 2022-02-15 16:52:32 -05:00
Jacky Zhao
10f9843bb6 Merge pull request #51 from brandonkboswell/patch-1 2022-02-15 14:51:29 -05:00
Jacky Zhao
0dc51ff39c Merge branch 'hugo' of https://github.com/jackyzha0/quartz into hugo 2022-02-15 14:50:34 -05:00
Jacky Zhao
c35086c510 visibility fix 2022-02-15 14:50:25 -05:00
Brandon Boswell
31297b7e5a Added to the Showcase 2022-02-12 22:35:03 -05:00
Jacky Zhao
fa3bc3de92 Merge pull request #48 from earnestma/earne/configurable-page-toc 2022-02-11 17:24:54 -05:00
earnest ma
41c443dbf0 Add disableToc parameter to not show TOC on a page 2022-02-11 17:15:28 -05:00
Jacky Zhao
a271fb9d74 Merge pull request #46 from adube/patch-1 2022-01-31 12:28:40 -08:00
Alexandre Dubé
49cdca5dfc Specify Hugo requires extended Sass/SCSS version
Hugo needs to be installed with its "extended" Sass/SCSS version, otherwise this template does not work.
2022-01-31 15:18:26 -05:00
Jacky Zhao
9645f00317 link fixing 2022-01-27 09:38:28 -08:00
Jacky Zhao
57ebf4c21c underscore fix, fix relative path being weird for graph 2022-01-10 13:08:50 -08:00
Jacky Zhao
54e3e071d1 fix popover regex 2022-01-10 09:00:45 -08:00
Jacky Zhao
d46e223831 revert baseurl fix 2022-01-10 08:51:00 -08:00
Jacky Zhao
6f9a29c174 various path fixes 2022-01-10 08:49:29 -08:00
Jacky Zhao
532bc61025 set relativeUrls to true 2022-01-05 19:42:13 -05:00
Jacky Zhao
99aea48260 docs update 2022-01-04 11:39:22 -05:00
92 changed files with 3649 additions and 1021 deletions

View File

@@ -7,21 +7,24 @@ on:
jobs:
deploy:
runs-on: ubuntu-18.04
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
- name: Build Link Index
uses: jackyzha0/hugo-obsidian@v2.7
uses: jackyzha0/hugo-obsidian@v2.20
with:
index: true
input: content
output: data
output: assets/indices
root: .
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.82.0'
hugo-version: '0.96.0'
extended: true
- name: Build
@@ -33,4 +36,4 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
publish_branch: master # deploying branch
cname: quartz.jzhao.xyz
cname: three.quartz.jzhao.xyz

42
.github/workflows/docker-publish.yaml vendored Normal file
View File

@@ -0,0 +1,42 @@
name: Create and publish a Docker image
on:
push:
branches: ['hugo']
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
jobs:
build-and-push-image:
if: github.repository == 'jackyzha0/quartz'
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Log in to the Container registry
uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
- name: Build and push Docker image
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

5
.gitignore vendored
View File

@@ -3,5 +3,6 @@ public
resources
.idea
content/.obsidian
data/linkIndex.yaml
data/contentIndex.yaml
assets/indices/linkIndex.json
assets/indices/contentIndex.json
linkmap

0
.hugo_build.lock Normal file
View File

7
.prettierrc Normal file
View File

@@ -0,0 +1,7 @@
{
"printWidth": 100,
"quoteProps": "as-needed",
"trailingComma": "all",
"tabWidth": 2,
"semi": false
}

11
Dockerfile Normal file
View File

@@ -0,0 +1,11 @@
FROM alpine:3.16
RUN apk add --no-cache go hugo git make perl
RUN git config --global --add safe.directory '/quartz'
RUN go install github.com/jackyzha0/hugo-obsidian@latest
ENV PATH="/root/go/bin:$PATH"
RUN git clone https://github.com/jackyzha0/quartz.git /quartz
WORKDIR /quartz
CMD ["make", "serve"]

View File

@@ -3,5 +3,22 @@
help: ## Show all Makefile targets
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
serve: ## serve
hugo-obsidian -input=content -output=data -index -root=. && hugo server
update: ## Update Quartz to the latest version on Github
go install github.com/jackyzha0/hugo-obsidian@latest
@git remote show upstream || (echo "remote 'upstream' not present, setting 'upstream'" && git remote add upstream https://github.com/jackyzha0/quartz.git)
git fetch upstream
git log --oneline --decorate --graph ..upstream/hugo
git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data
update-force: ## Forcefully pull all changes and don't ask to patch
go install github.com/jackyzha0/hugo-obsidian@latest
@git remote show upstream || (echo "remote 'upstream' not present, setting 'upstream'" && git remote add upstream https://github.com/jackyzha0/quartz.git)
git fetch upstream
git checkout upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data
serve: ## Serve Quartz locally
hugo-obsidian -input=content -output=assets/indices -index -root=.
hugo server --enableGitInfo --minify --bind=$(or $(HUGO_BIND),0.0.0.0) --baseURL=$(or $(HUGO_BASEURL),http://localhost) --port=$(or $(HUGO_PORT),1313) --appendPort=$(or $(HUGO_APPENDPORT),true) --liveReloadPort=$(or $(HUGO_LIVERELOADPORT),-1)
docker: ## Serve locally using Docker
docker run -it --volume=$(shell pwd):/quartz -p 1313:1313 ghcr.io/jackyzha0/quartz:hugo

View File

@@ -1,6 +1,23 @@
# Quartz
Host your own second brain and digital garden for free.
# Quartz 3
> [!warning]
> Quartz v3 is now deprecated and will no longer be maintained.
> See how to migrate to [Quartz 4](https://quartz.jzhao.xyz)
Host your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features
1. Extremely fast natural-language search
2. Customizable and hackable design based on Hugo
3. Automatically generated backlinks, link previews, and local graph
4. Built-in CJK + Latex Support and Admonition-style callouts
5. Support for both Markdown Links and Wikilinks
Check out some of the [amazing gardens that community members](https://quartz.jzhao.xyz/notes/showcase/) have published with Quartz!
> “[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming
🔗 Get Started: https://quartz.jzhao.xyz/
🔗 Get Started: https://three.quartz.jzhao.xyz/
![Quartz Example Screenshot](./screenshot.png)*Quartz Example Screenshot*
[Join the Discord Community](https://discord.gg/cRFFHYye7t)

0
assets/indices/.gitkeep Normal file
View File

6
assets/js/callouts.js Normal file
View File

@@ -0,0 +1,6 @@
const addCollapsibleCallouts = () => {
const collapsibleCallouts = document.querySelectorAll("blockquote.callout-collapsible");
collapsibleCallouts.forEach(el => el.addEventListener('click', event => {
event.currentTarget.classList.toggle("callout-collapsed");
}));
}

45
assets/js/clipboard.js Normal file
View File

@@ -0,0 +1,45 @@
const svgCopy =
'<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true"><path fill-rule="evenodd" d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z"></path><path fill-rule="evenodd" d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z"></path></svg>';
const svgCheck =
'<svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true"><path fill-rule="evenodd" fill="rgb(63, 185, 80)" d="M13.78 4.22a.75.75 0 010 1.06l-7.25 7.25a.75.75 0 01-1.06 0L2.22 9.28a.75.75 0 011.06-1.06L6 10.94l6.72-6.72a.75.75 0 011.06 0z"></path></svg>';
const addCopyButtons = () => {
let els = document.getElementsByClassName("highlight");
// for each highlight
for (let i = 0; i < els.length; i++) {
try {
if (els[i].getElementsByClassName("clipboard-button").length) continue;
// find pre > code inside els[i]
let codeBlocks = els[i].getElementsByTagName("code");
// line numbers are inside first code block
let lastCodeBlock = codeBlocks[codeBlocks.length - 1];
const button = document.createElement("button");
button.className = "clipboard-button";
button.type = "button";
button.innerHTML = svgCopy;
button.ariaLabel = "opy the shown code";
// remove every second newline from lastCodeBlock.innerText
button.addEventListener("click", () => {
navigator.clipboard.writeText(lastCodeBlock.innerText.replace(/\n\n/g, "\n")).then(
() => {
button.blur();
button.innerHTML = svgCheck;
setTimeout(() => {
button.innerHTML = svgCopy
button.style.borderColor = ""
}, 2000);
},
(error) => (button.innerHTML = "Error")
);
});
// find chroma inside els[i]
let chroma = els[i].getElementsByClassName("chroma")[0];
els[i].insertBefore(button, chroma);
} catch(error) {
console.debug(error);
}
}
}

17
assets/js/code-title.js Normal file
View File

@@ -0,0 +1,17 @@
function addTitleToCodeBlocks() {
const els = document.getElementsByClassName("highlight");
for (let i = 0; i < els.length; i++) {
try {
if (els[i].title.length) {
let div = document.createElement("div");
if (els[i].getElementsByClassName("code-title").length) continue;
div.textContent = els[i].title;
div.classList.add("code-title")
els[i].insertBefore(div, els[i].firstChild);
}
} catch (error) {
console.debug(error);
}
}
}

View File

@@ -1,18 +1,26 @@
const userPref = window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark'
const currentTheme = localStorage.getItem('theme') ?? userPref
const syntaxTheme = document.querySelector("#theme-link");
{{ $darkSyntax := resources.Get "styles/_dark_syntax.scss" | resources.ToCSS (dict "outputStyle" "compressed") | resources.Fingerprint "md5" | resources.Minify }}
{{ $lightSyntax := resources.Get "styles/_light_syntax.scss" | resources.ToCSS (dict "outputStyle" "compressed") | resources.Fingerprint "md5" | resources.Minify }}
if (currentTheme) {
document.documentElement.setAttribute('saved-theme', currentTheme);
syntaxTheme.href = currentTheme === 'dark' ? '{{ $darkSyntax.Permalink }}' : '{{ $lightSyntax.Permalink }}';
}
const switchTheme = (e) => {
if (e.target.checked) {
document.documentElement.setAttribute('saved-theme', 'dark')
localStorage.setItem('theme', 'dark')
document.documentElement.setAttribute('saved-theme', 'dark');
localStorage.setItem('theme', 'dark');
syntaxTheme.href = '{{ $darkSyntax.Permalink }}';
}
else {
document.documentElement.setAttribute('saved-theme', 'light')
localStorage.setItem('theme', 'light')
syntaxTheme.href = '{{ $lightSyntax.Permalink }}';
}
}

View File

@@ -0,0 +1,61 @@
; (async function() {
const encoder = (str) => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])/)
const contentIndex = new FlexSearch.Document({
cache: true,
charset: "latin:extra",
optimize: true,
index: [
{
field: "content",
tokenize: "reverse",
encode: encoder,
},
{
field: "title",
tokenize: "forward",
encode: encoder,
},
],
})
const { content } = await fetchData
for (const [key, value] of Object.entries(content)) {
contentIndex.add({
id: key,
title: value.title,
content: removeMarkdown(value.content),
})
}
const formatForDisplay = (id) => ({
id,
url: id,
title: content[id].title,
content: content[id].content,
})
registerHandlers((e) => {
const term = e.target.value
const searchResults = contentIndex.search(term, [
{
field: "content",
limit: 10,
},
{
field: "title",
limit: 5,
},
])
const getByField = (field) => {
const results = searchResults.filter((x) => x.field === field)
if (results.length === 0) {
return []
} else {
return [...results[0].result]
}
}
const allIds = new Set([...getByField("title"), ...getByField("content")])
const finalResults = [...allIds].map(formatForDisplay)
displayResults(term, finalResults, true)
})
})()

279
assets/js/graph.js Normal file
View File

@@ -0,0 +1,279 @@
async function drawGraph(baseUrl, isHome, pathColors, graphConfig) {
let {
depth,
enableDrag,
enableLegend,
enableZoom,
opacityScale,
scale,
repelForce,
fontSize } = graphConfig;
const container = document.getElementById("graph-container")
const { index, links, content } = await fetchData
// Use .pathname to remove hashes / searchParams / text fragments
const cleanUrl = window.location.origin + window.location.pathname
const curPage = cleanUrl.replace(/\/$/g, "").replace(baseUrl, "")
const parseIdsFromLinks = (links) => [
...new Set(links.flatMap((link) => [link.source, link.target])),
]
// Links is mutated by d3. We want to use links later on, so we make a copy and pass that one to d3
// Note: shallow cloning does not work because it copies over references from the original array
const copyLinks = JSON.parse(JSON.stringify(links))
const neighbours = new Set()
const wl = [curPage || "/", "__SENTINEL"]
if (depth >= 0) {
while (depth >= 0 && wl.length > 0) {
// compute neighbours
const cur = wl.shift()
if (cur === "__SENTINEL") {
depth--
wl.push("__SENTINEL")
} else {
neighbours.add(cur)
const outgoing = index.links[cur] || []
const incoming = index.backlinks[cur] || []
wl.push(...outgoing.map((l) => l.target), ...incoming.map((l) => l.source))
}
}
} else {
parseIdsFromLinks(copyLinks).forEach((id) => neighbours.add(id))
}
const data = {
nodes: [...neighbours].map((id) => ({ id })),
links: copyLinks.filter((l) => neighbours.has(l.source) && neighbours.has(l.target)),
}
const color = (d) => {
if (d.id === curPage || (d.id === "/" && curPage === "")) {
return "var(--g-node-active)"
}
for (const pathColor of pathColors) {
const path = Object.keys(pathColor)[0]
const colour = pathColor[path]
if (d.id.startsWith(path)) {
return colour
}
}
return "var(--g-node)"
}
const drag = (simulation) => {
function dragstarted(event, d) {
if (!event.active) simulation.alphaTarget(1).restart()
d.fx = d.x
d.fy = d.y
}
function dragged(event, d) {
d.fx = event.x
d.fy = event.y
}
function dragended(event, d) {
if (!event.active) simulation.alphaTarget(0)
d.fx = null
d.fy = null
}
const noop = () => { }
return d3
.drag()
.on("start", enableDrag ? dragstarted : noop)
.on("drag", enableDrag ? dragged : noop)
.on("end", enableDrag ? dragended : noop)
}
const height = Math.max(container.offsetHeight, isHome ? 500 : 250)
const width = container.offsetWidth
const simulation = d3
.forceSimulation(data.nodes)
.force("charge", d3.forceManyBody().strength(-100 * repelForce))
.force(
"link",
d3
.forceLink(data.links)
.id((d) => d.id)
.distance(40),
)
.force("center", d3.forceCenter())
const svg = d3
.select("#graph-container")
.append("svg")
.attr("width", width)
.attr("height", height)
.attr('viewBox', [-width / 2 / scale, -height / 2 / scale, width / scale, height / scale])
if (enableLegend) {
const legend = [{ Current: "var(--g-node-active)" }, { Note: "var(--g-node)" }, ...pathColors]
legend.forEach((legendEntry, i) => {
const key = Object.keys(legendEntry)[0]
const colour = legendEntry[key]
svg
.append("circle")
.attr("cx", -width / 2 + 20)
.attr("cy", height / 2 - 30 * (i + 1))
.attr("r", 6)
.style("fill", colour)
svg
.append("text")
.attr("x", -width / 2 + 40)
.attr("y", height / 2 - 30 * (i + 1))
.text(key)
.style("font-size", "15px")
.attr("alignment-baseline", "middle")
})
}
// draw links between nodes
const link = svg
.append("g")
.selectAll("line")
.data(data.links)
.join("line")
.attr("class", "link")
.attr("stroke", "var(--g-link)")
.attr("stroke-width", 2)
.attr("data-source", (d) => d.source.id)
.attr("data-target", (d) => d.target.id)
// svg groups
const graphNode = svg.append("g").selectAll("g").data(data.nodes).enter().append("g")
// calculate radius
const nodeRadius = (d) => {
const numOut = index.links[d.id]?.length || 0
const numIn = index.backlinks[d.id]?.length || 0
return 2 + Math.sqrt(numOut + numIn)
}
// draw individual nodes
const node = graphNode
.append("circle")
.attr("class", "node")
.attr("id", (d) => d.id)
.attr("r", nodeRadius)
.attr("fill", color)
.style("cursor", "pointer")
.on("click", (_, d) => {
// SPA navigation
const targ = `${baseUrl}${decodeURI(d.id).replace(/\s+/g, "-")}/`
window.Million.navigate(new URL(targ), ".singlePage")
plausible("Link Click", {
props: {
href: targ,
broken: false,
internal: true,
graph: true,
}
})
})
.on("mouseover", function(_, d) {
d3.selectAll(".node").transition().duration(100).attr("fill", "var(--g-node-inactive)")
const neighbours = parseIdsFromLinks([
...(index.links[d.id] || []),
...(index.backlinks[d.id] || []),
])
const neighbourNodes = d3.selectAll(".node").filter((d) => neighbours.includes(d.id))
const currentId = d.id
window.Million.prefetch(new URL(`${baseUrl}${decodeURI(d.id).replace(/\s+/g, "-")}/`))
const linkNodes = d3
.selectAll(".link")
.filter((d) => d.source.id === currentId || d.target.id === currentId)
// highlight neighbour nodes
neighbourNodes.transition().duration(200).attr("fill", color)
// highlight links
linkNodes.transition().duration(200).attr("stroke", "var(--g-link-active)")
const bigFont = fontSize * 1.5
// show text for self
d3.select(this.parentNode)
.raise()
.select("text")
.transition()
.duration(200)
.attr('opacityOld', d3.select(this.parentNode).select('text').style("opacity"))
.style('opacity', 1)
.style('font-size', bigFont + 'em')
.attr('dy', d => nodeRadius(d) + 20 + 'px') // radius is in px
})
.on("mouseleave", function(_, d) {
d3.selectAll(".node").transition().duration(200).attr("fill", color)
const currentId = d.id
const linkNodes = d3
.selectAll(".link")
.filter((d) => d.source.id === currentId || d.target.id === currentId)
linkNodes.transition().duration(200).attr("stroke", "var(--g-link)")
d3.select(this.parentNode)
.select("text")
.transition()
.duration(200)
.style('opacity', d3.select(this.parentNode).select('text').attr("opacityOld"))
.style('font-size', fontSize + 'em')
.attr('dy', d => nodeRadius(d) + 8 + 'px') // radius is in px
})
.call(drag(simulation))
// draw labels
const labels = graphNode
.append("text")
.attr("dx", 0)
.attr("dy", (d) => nodeRadius(d) + 8 + "px")
.attr("text-anchor", "middle")
.text((d) => content[d.id]?.title || (d.id.charAt(1).toUpperCase() + d.id.slice(2)).replace("-", " "))
.style('opacity', (opacityScale - 1) / 3.75)
.style("pointer-events", "none")
.style('font-size', fontSize + 'em')
.raise()
.call(drag(simulation))
// set panning
if (enableZoom) {
svg.call(
d3
.zoom()
.extent([
[0, 0],
[width, height],
])
.scaleExtent([0.25, 4])
.on("zoom", ({ transform }) => {
link.attr("transform", transform)
node.attr("transform", transform)
const scale = transform.k * opacityScale;
const scaledOpacity = Math.max((scale - 1) / 3.75, 0)
labels.attr("transform", transform).style("opacity", scaledOpacity)
}),
)
}
// progress the simulation
simulation.on("tick", () => {
link
.attr("x1", (d) => d.source.x)
.attr("y1", (d) => d.source.y)
.attr("x2", (d) => d.target.x)
.attr("y2", (d) => d.target.y)
node.attr("cx", (d) => d.x).attr("cy", (d) => d.y)
labels.attr("x", (d) => d.x).attr("y", (d) => d.y)
})
}

79
assets/js/popover.js Normal file
View File

@@ -0,0 +1,79 @@
function htmlToElement(html) {
const template = document.createElement("template")
html = html.trim()
template.innerHTML = html
return template.content.firstChild
}
function initPopover(baseURL, useContextualBacklinks) {
const basePath = baseURL.replace(window.location.origin, "")
fetchData.then(({ content }) => {
const links = [...document.getElementsByClassName("internal-link")]
links
.filter(li => li.dataset.src || (li.dataset.idx && useContextualBacklinks))
.forEach(li => {
let el
if (li.dataset.ctx) {
const linkDest = content[li.dataset.src]
const popoverElement = `<div class="popover">
<h3>${linkDest.title}</h3>
<p>${highlight(removeMarkdown(linkDest.content), li.dataset.ctx)}...</p>
<p class="meta">${new Date(linkDest.lastmodified).toLocaleDateString()}</p>
</div>`
el = htmlToElement(popoverElement)
} else {
const linkDest = content[li.dataset.src.replace(/\/$/g, "").replace(basePath, "")]
if (linkDest) {
let splitLink = li.href.split("#")
let cleanedContent = removeMarkdown(linkDest.content)
if (splitLink.length > 1) {
let headingName = decodeURIComponent(splitLink[1]).replace(/\-/g, " ")
let headingIndex = cleanedContent.toLowerCase().indexOf("<b>" + headingName + "</b>")
cleanedContent = cleanedContent.substring(headingIndex, cleanedContent.length)
}
const popoverElement = `<div class="popover">
<h3>${linkDest.title}</h3>
<p>${cleanedContent.split(" ", 20).join(" ")}...</p>
<p class="meta">${new Date(linkDest.lastmodified).toLocaleDateString()}</p>
</div>`
el = htmlToElement(popoverElement)
}
}
if (el) {
li.appendChild(el)
if (LATEX_ENABLED) {
renderMathInElement(el, {
delimiters: [
{ left: '$$', right: '$$', display: false },
{ left: '$', right: '$', display: false },
],
throwOnError: false
})
}
li.addEventListener("mouseover", () => {
// fix tooltip positioning
window.FloatingUIDOM.computePosition(li, el, {
middleware: [window.FloatingUIDOM.offset(10), window.FloatingUIDOM.inline(), window.FloatingUIDOM.shift()],
}).then(({ x, y }) => {
Object.assign(el.style, {
left: `${x}px`,
top: `${y}px`,
})
})
el.classList.add("visible")
plausible("Popover Hover", {
props: {
href: li.dataset.src
}
})
})
li.addEventListener("mouseout", () => {
el.classList.remove("visible")
})
}
})
})
}

25
assets/js/router.js Normal file
View File

@@ -0,0 +1,25 @@
import {
apply,
navigate,
prefetch,
router,
} from "https://unpkg.com/million@1.11.5/dist/router.mjs"
export const attachSPARouting = (init, rerender) => {
// Attach SPA functions to the global Million namespace
window.Million = {
apply,
navigate,
prefetch,
router,
}
const render = () => requestAnimationFrame(rerender)
window.addEventListener("DOMContentLoaded", () => {
apply((doc) => init(doc))
init()
router(".singlePage")
render()
})
window.addEventListener("million:navigate", render)
}

View File

@@ -0,0 +1,54 @@
// Note: Currently, we use the REST API for Operand because of some unpkg/webpack issues.
// In the future, we'd like to use the SDK (https://github.com/operandinc/typescript-sdk).
// If someone knows how to do this w/o breaking the Operand typescript-sdk for npm users,
// please let Morgan (@morgallant) and/or (@_jzhao) know! <3
const apiKey = "{{$.Site.Data.config.search.operandApiKey}}"
const indexId = "{{$.Site.Data.config.search.operandIndexId}}"
function parseSearchResults(searchResults) {
return searchResults.matches.map((m) => ({
content: m.content,
title: searchResults.objects[m.objectId].properties.properties._title.text,
url: searchResults.objects[m.objectId].properties.properties._url.text,
}))
}
async function searchContents(query) {
const result = await fetch("https://api.operand.ai/operand.v1.ObjectService/SearchWithin", {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `${apiKey}`,
"Operand-Index-ID": `${indexId}`,
},
body: JSON.stringify({
query: query,
limit: 10,
}),
})
if (result.ok) {
return parseSearchResults(await result.json())
} else {
console.error(result)
}
}
function debounce(func, timeout = 200) {
let timer
return (...args) => {
clearTimeout(timer)
timer = setTimeout(() => {
func.apply(this, args)
}, timeout)
}
}
registerHandlers(
debounce((e) => {
let term = e.target.value
if (term !== "") {
searchContents(term).then((results) => displayResults(term, results))
}
}),
)

226
assets/js/util.js Normal file
View File

@@ -0,0 +1,226 @@
// code from https://github.com/danestves/markdown-to-text
const removeMarkdown = (
markdown,
options = {
listUnicodeChar: false,
stripListLeaders: true,
gfm: true,
useImgAltText: false,
preserveLinks: false,
},
) => {
let output = markdown || ""
output = output.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm, "")
try {
if (options.stripListLeaders) {
if (options.listUnicodeChar)
output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, options.listUnicodeChar + " $1")
else output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, "$1")
}
if (options.gfm) {
output = output
.replace(/\n={2,}/g, "\n")
.replace(/~{3}.*\n/g, "")
.replace(/~~/g, "")
.replace(/`{3}.*\n/g, "")
}
if (options.preserveLinks) {
output = output.replace(/\[(.*?)\][\[\(](.*?)[\]\)]/g, "$1 ($2)")
}
output = output
.replace(/<[^>]*>/g, "")
.replace(/^[=\-]{2,}\s*$/g, "")
.replace(/\[\^.+?\](\: .*?$)?/g, "")
.replace(/(#{1,6})\s+(.+)\1?/g, "<b>$2</b>")
.replace(/\s{0,2}\[.*?\]: .*?$/g, "")
.replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g, options.useImgAltText ? "$1" : "")
.replace(/\[(.*?)\][\[\(].*?[\]\)]/g, "<a>$1</a>")
.replace(/!?\[\[\S[^\[\]\|]*(?:\|([^\[\]]*))?\S\]\]/g, "<a>$1</a>")
.replace(/^\s{0,3}>\s?/g, "")
.replace(/(^|\n)\s{0,3}>\s?/g, "\n\n")
.replace(/^\s{1,2}\[(.*?)\]: (\S+)( ".*?")?\s*$/g, "")
.replace(/([\*_]{1,3})(\S.*?\S?)\1/g, "$2")
.replace(/([\*_]{1,3})(\S.*?\S?)\1/g, "$2")
.replace(/(`{3,})(.*?)\1/gm, "$2")
.replace(/`(.+?)`/g, "$1")
.replace(/\n{2,}/g, "\n\n")
.replace(/\[![a-zA-Z]+\][-\+]? /g, "")
} catch (e) {
console.error(e)
return markdown
}
return output
}
const highlight = (content, term) => {
const highlightWindow = 20
// try to find direct match first
const directMatchIdx = content.indexOf(term)
if (directMatchIdx !== -1) {
const h = highlightWindow
const before = content.substring(0, directMatchIdx).split(" ").slice(-h)
const after = content
.substring(directMatchIdx + term.length, content.length - 2)
.split(" ")
.slice(0, h)
return (
(before.length === h ? `...${before.join(" ")}` : before.join(" ")) +
`<span class="search-highlight">${term}</span>` +
after.join(" ")
)
}
const tokenizedTerm = term.split(/\s+/).filter((t) => t !== "")
const splitText = content.split(/\s+/).filter((t) => t !== "")
const includesCheck = (token) =>
tokenizedTerm.some((term) => token.toLowerCase().startsWith(term.toLowerCase()))
const occurrencesIndices = splitText.map(includesCheck)
// calculate best index
let bestSum = 0
let bestIndex = 0
for (let i = 0; i < Math.max(occurrencesIndices.length - highlightWindow, 0); i++) {
const window = occurrencesIndices.slice(i, i + highlightWindow)
const windowSum = window.reduce((total, cur) => total + cur, 0)
if (windowSum >= bestSum) {
bestSum = windowSum
bestIndex = i
}
}
const startIndex = Math.max(bestIndex - highlightWindow, 0)
const endIndex = Math.min(startIndex + 2 * highlightWindow, splitText.length)
const mappedText = splitText
.slice(startIndex, endIndex)
.map((token) => {
if (includesCheck(token)) {
return `<span class="search-highlight">${token}</span>`
}
return token
})
.join(" ")
.replaceAll('</span> <span class="search-highlight">', " ")
return `${startIndex === 0 ? "" : "..."}${mappedText}${endIndex === splitText.length ? "" : "..."
}`
}
// Common utilities for search
const resultToHTML = ({ url, title, content }) => {
return `<button class="result-card" id="${url}">
<h3>${title}</h3>
<p>${content}</p>
</button>`
}
const redir = (id, term) => {
const shouldTrim = PRODUCTION && SEARCH_ENABLED
const baseURLPrefix = shouldTrim ? "" : BASE_URL.replace(/\/$/g, "")
const urlString = `${baseURLPrefix}${id}#:~:text=${encodeURIComponent(term)}`
window.Million.navigate(
new URL(urlString),
".singlePage",
)
closeSearch()
plausible("Search", {
props: {
term
}
})
}
function openSearch() {
const source = document.getElementById("search-bar")
const results = document.getElementById("results-container")
const searchContainer = document.getElementById("search-container")
if (searchContainer.style.display === "none" || searchContainer.style.display === "") {
source.value = ""
results.innerHTML = ""
searchContainer.style.display = "block"
source.focus()
} else {
searchContainer.style.display = "none"
}
}
function closeSearch() {
const searchContainer = document.getElementById("search-container")
searchContainer.style.display = "none"
}
const registerHandlers = (onInputFn) => {
const source = document.getElementById("search-bar")
const searchContainer = document.getElementById("search-container")
let term
source.addEventListener("keyup", (e) => {
if (e.key === "Enter") {
const anchor = document.getElementsByClassName("result-card")[0]
redir(anchor.id, term)
}
})
source.addEventListener("input", onInputFn)
document.addEventListener("keydown", (event) => {
if (event.key === "k" && (event.ctrlKey || event.metaKey)) {
event.preventDefault()
openSearch()
}
if (event.key === "Escape") {
event.preventDefault()
closeSearch()
}
})
const searchButton = document.getElementById("search-icon")
searchButton.addEventListener("click", (_) => {
openSearch()
})
searchButton.addEventListener("keydown", (_) => {
openSearch()
})
searchContainer.addEventListener("click", (_) => {
closeSearch()
})
document.getElementById("search-space").addEventListener("click", (evt) => {
evt.stopPropagation()
})
}
const displayResults = (term, finalResults, extractHighlight = false) => {
const results = document.getElementById("results-container")
if (finalResults.length === 0) {
results.innerHTML = `<button class="result-card">
<h3>No results.</h3>
<p>Try another search term?</p>
</button>`
} else {
results.innerHTML = finalResults
.map((result) => {
if (extractHighlight) {
return resultToHTML({
url: result.url,
title: highlight(result.title, term),
content: highlight(removeMarkdown(result.content), term)
})
} else {
return resultToHTML(result)
}
}
)
.join("\n")
if (LATEX_ENABLED) {
renderMathInElement(results, {
delimiters: [
{ left: '$$', right: '$$', display: false },
{ left: '$', right: '$', display: false },
],
throwOnError: false
})
}
const anchors = [...document.getElementsByClassName("result-card")]
anchors.forEach((anchor) => {
anchor.onclick = () => redir(anchor.id, term)
})
}
}

View File

@@ -0,0 +1,174 @@
:root {
--callout-summary: #00b0ff;
--callout-summary-accent: #7fd7ff;
--callout-bug: #f50057;
--callout-bug-accent: #ff7aa9;
--callout-danger: #ff1744;
--callout-danger-accent: #ff8aa1;
--callout-example: #7c4dff;
--callout-example-accent: #bda5ff;
--callout-fail: #ff5252;
--callout-fail-accent: #ffa8a8;
--callout-info: #00b8d4;
--callout-info-accent: #69ebff;
--callout-note: #448aff;
--callout-note-accent: #a1c4ff;
--callout-question: #64dd17;
--callout-question-accent: #b0f286;
--callout-quote: #9e9e9e;
--callout-quote-accent: #cecece;
--callout-done: #00c853;
--callout-done-accent: #63ffa4;
--callout-important: #00bfa5;
--callout-important-accent: #5fffe9;
--callout-warning: #ff9100;
--callout-warning-accent: #ffc87f;
}
[saved-theme=dark] {
--callout-summary: #00b0ff !important;
--callout-summary-accent: #00587f !important;
--callout-bug: #f50057 !important;
--callout-bug-accent: #7a002b !important;
--callout-danger: #ff1744 !important;
--callout-danger-accent: #8b001a !important;
--callout-example: #7c4dff !important;
--callout-example-accent: #2b00a6 !important;
--callout-fail: #ff5252 !important;
--callout-fail-accent: #a80000 !important;
--callout-info: #00b8d4 !important;
--callout-info-accent: #005c6a !important;
--callout-note: #448aff !important;
--callout-note-accent: #003ca1 !important;
--callout-question: #64dd17 !important;
--callout-question-accent: #006429 !important;
--callout-quote: #9e9e9e !important;
--callout-quote-accent: #4f4f4f !important;
--callout-done: #00c853 !important;
--callout-done-accent: #006429 !important;
--callout-important: #00bfa5 !important;
--callout-important-accent: #005f52 !important;
--callout-warning: #ff9100 !important;
--callout-warning-accent: #7f4800 !important;
}
blockquote.callout-collapsible {
cursor: pointer;
&.callout-collapsible::after {
content: '-';
right: 6px;
font-weight: bolder;
font-family: Courier New, Courier, monospace;
}
}
blockquote.callout-collapsed {
& > p { border-bottom-right-radius: 5px !important; }
padding-bottom: 0 !important;
&::after {
content: '+' !important;
}
& > *:not(:first-child) {
display: none !important;
}
}
blockquote[class*="-callout"] {
margin-right: 0;
border-radius: 5px;
position: relative;
padding-left: 0 !important;
padding-bottom: 0.25em;
color: var(--dark);
background-color: var(--lightgray);
border-left: 6px solid var(--primary) !important;
& > p {
border-top-right-radius: 5px;
padding: 0.5em 1em;
margin: 0;
color: var(--gray);
&:first-child {
font-weight: 600;
color: var(--dark);
padding: 0.4em 30px;
}
}
}
blockquote[class*="-callout"] > p:first-child::after, blockquote.callout-collapsible::after {
display: inline-block;
height: 18px;
width: 18px;
position: absolute;
top: 0.4em;
margin: 0.2em 0.4em;
}
blockquote[class*="-callout"] > p:first-child {
font-weight: bold;
padding: 0.4em 35px;
&::after {
left: 0;
}
}
blockquote[class*="-callout"] > p:empty {
padding: 1.2em 35px;
}
$summary: summary, abstract, tldr;
$bug: bug;
$danger: danger, error;
$example: example;
$fail: fail, failure, missing;
$info: info, todo;
$note: note;
$question: question, help, faq;
$quote: quote, cite;
$done: done, success, check;
$important: important, tip, hint;
$warning: warning, caution, attention;
$types: $summary, $bug, $danger, $example, $fail, $info, $note, $question, $quote, $done, $important, $warning;
$svgs: ();
$svgs: map-merge($svgs, ($summary: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='book' class='svg-inline--callout-fa fa-book fa-w-14' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'%3E%3Cpath fill='currentColor' d='M448 360V24c0-13.3-10.7-24-24-24H96C43 0 0 43 0 96v320c0 53 43 96 96 96h328c13.3 0 24-10.7 24-24v-16c0-7.5-3.5-14.3-8.9-18.7-4.2-15.4-4.2-59.3 0-74.7 5.4-4.3 8.9-11.1 8.9-18.6zM128 134c0-3.3 2.7-6 6-6h212c3.3 0 6 2.7 6 6v20c0 3.3-2.7 6-6 6H134c-3.3 0-6-2.7-6-6v-20zm0 64c0-3.3 2.7-6 6-6h212c3.3 0 6 2.7 6 6v20c0 3.3-2.7 6-6 6H134c-3.3 0-6-2.7-6-6v-20zm253.4 250H96c-17.7 0-32-14.3-32-32 0-17.6 14.4-32 32-32h285.4c-1.9 17.1-1.9 46.9 0 64z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($bug: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='bug' class='svg-inline--callout-fa fa-bug fa-w-16' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='currentColor' d='M511.988 288.9c-.478 17.43-15.217 31.1-32.653 31.1H424v16c0 21.864-4.882 42.584-13.6 61.145l60.228 60.228c12.496 12.497 12.496 32.758 0 45.255-12.498 12.497-32.759 12.496-45.256 0l-54.736-54.736C345.886 467.965 314.351 480 280 480V236c0-6.627-5.373-12-12-12h-24c-6.627 0-12 5.373-12 12v244c-34.351 0-65.886-12.035-90.636-32.108l-54.736 54.736c-12.498 12.497-32.759 12.496-45.256 0-12.496-12.497-12.496-32.758 0-45.255l60.228-60.228C92.882 378.584 88 357.864 88 336v-16H32.666C15.23 320 .491 306.33.013 288.9-.484 270.816 14.028 256 32 256h56v-58.745l-46.628-46.628c-12.496-12.497-12.496-32.758 0-45.255 12.498-12.497 32.758-12.497 45.256 0L141.255 160h229.489l54.627-54.627c12.498-12.497 32.758-12.497 45.256 0 12.496 12.497 12.496 32.758 0 45.255L424 197.255V256h56c17.972 0 32.484 14.816 31.988 32.9zM257 0c-61.856 0-112 50.144-112 112h224C369 50.144 318.856 0 257 0z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($danger: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='bolt' class='svg-inline--callout-fa fa-bolt fa-w-10' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 320 512'%3E%3Cpath fill='currentColor' d='M296 160H180.6l42.6-129.8C227.2 15 215.7 0 200 0H56C44 0 33.8 8.9 32.2 20.8l-32 240C-1.7 275.2 9.5 288 24 288h118.7L96.6 482.5c-3.6 15.2 8 29.5 23.3 29.5 8.4 0 16.4-4.4 20.8-12l176-304c9.3-15.9-2.2-36-20.7-36z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($example: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='list-ol' class='svg-inline--callout-fa fa-list-ol fa-w-16' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='currentColor' d='M61.77 401l17.5-20.15a19.92 19.92 0 0 0 5.07-14.19v-3.31C84.34 356 80.5 352 73 352H16a8 8 0 0 0-8 8v16a8 8 0 0 0 8 8h22.83a157.41 157.41 0 0 0-11 12.31l-5.61 7c-4 5.07-5.25 10.13-2.8 14.88l1.05 1.93c3 5.76 6.29 7.88 12.25 7.88h4.73c10.33 0 15.94 2.44 15.94 9.09 0 4.72-4.2 8.22-14.36 8.22a41.54 41.54 0 0 1-15.47-3.12c-6.49-3.88-11.74-3.5-15.6 3.12l-5.59 9.31c-3.72 6.13-3.19 11.72 2.63 15.94 7.71 4.69 20.38 9.44 37 9.44 34.16 0 48.5-22.75 48.5-44.12-.03-14.38-9.12-29.76-28.73-34.88zM496 224H176a16 16 0 0 0-16 16v32a16 16 0 0 0 16 16h320a16 16 0 0 0 16-16v-32a16 16 0 0 0-16-16zm0-160H176a16 16 0 0 0-16 16v32a16 16 0 0 0 16 16h320a16 16 0 0 0 16-16V80a16 16 0 0 0-16-16zm0 320H176a16 16 0 0 0-16 16v32a16 16 0 0 0 16 16h320a16 16 0 0 0 16-16v-32a16 16 0 0 0-16-16zM16 160h64a8 8 0 0 0 8-8v-16a8 8 0 0 0-8-8H64V40a8 8 0 0 0-8-8H32a8 8 0 0 0-7.14 4.42l-8 16A8 8 0 0 0 24 64h8v64H16a8 8 0 0 0-8 8v16a8 8 0 0 0 8 8zm-3.91 160H80a8 8 0 0 0 8-8v-16a8 8 0 0 0-8-8H41.32c3.29-10.29 48.34-18.68 48.34-56.44 0-29.06-25-39.56-44.47-39.56-21.36 0-33.8 10-40.46 18.75-4.37 5.59-3 10.84 2.8 15.37l8.58 6.88c5.61 4.56 11 2.47 16.12-2.44a13.44 13.44 0 0 1 9.46-3.84c3.33 0 9.28 1.56 9.28 8.75C51 248.19 0 257.31 0 304.59v4C0 316 5.08 320 12.09 320z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($fail: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='times-circle' class='svg-inline--callout-fa fa-times-circle fa-w-16' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='currentColor' d='M256 8C119 8 8 119 8 256s111 248 248 248 248-111 248-248S393 8 256 8zm121.6 313.1c4.7 4.7 4.7 12.3 0 17L338 377.6c-4.7 4.7-12.3 4.7-17 0L256 312l-65.1 65.6c-4.7 4.7-12.3 4.7-17 0L134.4 338c-4.7-4.7-4.7-12.3 0-17l65.6-65-65.6-65.1c-4.7-4.7-4.7-12.3 0-17l39.6-39.6c4.7-4.7 12.3-4.7 17 0l65 65.7 65.1-65.6c4.7-4.7 12.3-4.7 17 0l39.6 39.6c4.7 4.7 4.7 12.3 0 17L312 256l65.6 65.1z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($info: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='info-circle' class='svg-inline--callout-fa fa-info-circle fa-w-16' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='currentColor' d='M256 8C119.043 8 8 119.083 8 256c0 136.997 111.043 248 248 248s248-111.003 248-248C504 119.083 392.957 8 256 8zm0 110c23.196 0 42 18.804 42 42s-18.804 42-42 42-42-18.804-42-42 18.804-42 42-42zm56 254c0 6.627-5.373 12-12 12h-88c-6.627 0-12-5.373-12-12v-24c0-6.627 5.373-12 12-12h12v-64h-12c-6.627 0-12-5.373-12-12v-24c0-6.627 5.373-12 12-12h64c6.627 0 12 5.373 12 12v100h12c6.627 0 12 5.373 12 12v24z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($note: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='pencil-alt' class='svg-inline--callout-fa fa-pencil-alt fa-w-16' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='currentColor' d='M497.9 142.1l-46.1 46.1c-4.7 4.7-12.3 4.7-17 0l-111-111c-4.7-4.7-4.7-12.3 0-17l46.1-46.1c18.7-18.7 49.1-18.7 67.9 0l60.1 60.1c18.8 18.7 18.8 49.1 0 67.9zM284.2 99.8L21.6 362.4.4 483.9c-2.9 16.4 11.4 30.6 27.8 27.8l121.5-21.3 262.6-262.6c4.7-4.7 4.7-12.3 0-17l-111-111c-4.8-4.7-12.4-4.7-17.1 0zM124.1 339.9c-5.5-5.5-5.5-14.3 0-19.8l154-154c5.5-5.5 14.3-5.5 19.8 0s5.5 14.3 0 19.8l-154 154c-5.5 5.5-14.3 5.5-19.8 0zM88 424h48v36.3l-64.5 11.3-31.1-31.1L51.7 376H88v48z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($question: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='question-circle' class='svg-inline--callout-fa fa-question-circle fa-w-16' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='currentColor' d='M504 256c0 136.997-111.043 248-248 248S8 392.997 8 256C8 119.083 119.043 8 256 8s248 111.083 248 248zM262.655 90c-54.497 0-89.255 22.957-116.549 63.758-3.536 5.286-2.353 12.415 2.715 16.258l34.699 26.31c5.205 3.947 12.621 3.008 16.665-2.122 17.864-22.658 30.113-35.797 57.303-35.797 20.429 0 45.698 13.148 45.698 32.958 0 14.976-12.363 22.667-32.534 33.976C247.128 238.528 216 254.941 216 296v4c0 6.627 5.373 12 12 12h56c6.627 0 12-5.373 12-12v-1.333c0-28.462 83.186-29.647 83.186-106.667 0-58.002-60.165-102-116.531-102zM256 338c-25.365 0-46 20.635-46 46 0 25.364 20.635 46 46 46s46-20.636 46-46c0-25.365-20.635-46-46-46z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($quote: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='quote-right' class='svg-inline--callout-fa fa-quote-right fa-w-16' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='currentColor' d='M464 32H336c-26.5 0-48 21.5-48 48v128c0 26.5 21.5 48 48 48h80v64c0 35.3-28.7 64-64 64h-8c-13.3 0-24 10.7-24 24v48c0 13.3 10.7 24 24 24h8c88.4 0 160-71.6 160-160V80c0-26.5-21.5-48-48-48zm-288 0H48C21.5 32 0 53.5 0 80v128c0 26.5 21.5 48 48 48h80v64c0 35.3-28.7 64-64 64h-8c-13.3 0-24 10.7-24 24v48c0 13.3 10.7 24 24 24h8c88.4 0 160-71.6 160-160V80c0-26.5-21.5-48-48-48z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($done: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='check-circle' class='svg-inline--callout-fa fa-check-circle fa-w-16' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='currentColor' d='M504 256c0 136.967-111.033 248-248 248S8 392.967 8 256 119.033 8 256 8s248 111.033 248 248zM227.314 387.314l184-184c6.248-6.248 6.248-16.379 0-22.627l-22.627-22.627c-6.248-6.249-16.379-6.249-22.628 0L216 308.118l-70.059-70.059c-6.248-6.248-16.379-6.248-22.628 0l-22.627 22.627c-6.248 6.248-6.248 16.379 0 22.627l104 104c6.249 6.249 16.379 6.249 22.628.001z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($important: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='fire' class='svg-inline--callout-fa fa-fire fa-w-12' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 384 512'%3E%3Cpath fill='currentColor' d='M216 23.86c0-23.8-30.65-32.77-44.15-13.04C48 191.85 224 200 224 288c0 35.63-29.11 64.46-64.85 63.99-35.17-.45-63.15-29.77-63.15-64.94v-85.51c0-21.7-26.47-32.23-41.43-16.5C27.8 213.16 0 261.33 0 320c0 105.87 86.13 192 192 192s192-86.13 192-192c0-170.29-168-193-168-296.14z'%3E%3C/path%3E%3C/svg%3E")));
$svgs: map-merge($svgs, ($warning: url("data:image/svg+xml,%3Csvg aria-hidden='true' focusable='false' data-icon='exclamation-triangle' class='svg-inline--callout-fa fa-exclamation-triangle fa-w-18' role='img' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 576 512'%3E%3Cpath fill='currentColor' d='M569.517 440.013C587.975 472.007 564.806 512 527.94 512H48.054c-36.937 0-59.999-40.055-41.577-71.987L246.423 23.985c18.467-32.009 64.72-31.951 83.154 0l239.94 416.028zM288 354c-25.405 0-46 20.595-46 46s20.595 46 46 46 46-20.595 46-46-20.595-46-46-46zm-43.673-165.346l7.418 136c.347 6.364 5.609 11.346 11.982 11.346h48.546c6.373 0 11.635-4.982 11.982-11.346l7.418-136c.375-6.874-5.098-12.654-11.982-12.654h-63.383c-6.884 0-12.356 5.78-11.981 12.654z'%3E%3C/path%3E%3C/svg%3E")));
@function getstr($l) {
$v: nth($l, 1);
@return $v;
}
@each $type in $types {
@each $s in $type {
blockquote.#{$s}-callout {
border-left: 6px solid var(--callout-#{getstr($type)}) !important;
& > p:first-child {
background-color: var(--callout-#{getstr($type)}-accent) !important;
&::after {
content: '';
-webkit-mask: map-get($svgs, $type);
mask: map-get($svgs, $type);
background-color: var(--callout-#{getstr($type)}) !important;
-webkit-mask-size: contain;
mask-size: contain;
-webkit-mask-repeat: no-repeat;
mask-repeat: no-repeat;
-webkit-mask-position: center;
mask-position: center;
}
}
}
}
}

View File

@@ -1,11 +1,14 @@
/* Background */ .chroma { color: #f8f8f2; background-color: #282a36; overflow: hidden }
/* Background */ .bg { color: #f8f8f2; background-color: #282a36; }
/* PreWrapper */ .chroma { color: #f8f8f2; background-color: #282a36; }
/* Other */ .chroma .x { }
/* Error */ .chroma .err { }
/* CodeLine */ .chroma .cl { }
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; }
/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc }
/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
/* LineHighlight */ .chroma .hl { background-color: #ffffcc }
/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
/* Line */ .chroma .line { display: flex; }
/* Keyword */ .chroma .k { color: #ff79c6 }
/* KeywordConstant */ .chroma .kc { color: #ff79c6 }
/* KeywordDeclaration */ .chroma .kd { color: #8be9fd; font-style: italic }
@@ -68,11 +71,11 @@
/* CommentPreproc */ .chroma .cp { color: #ff79c6 }
/* CommentPreprocFile */ .chroma .cpf { color: #ff79c6 }
/* Generic */ .chroma .g { }
/* GenericDeleted */ .chroma .gd { color: #8b080b }
/* GenericDeleted */ .chroma .gd { color: #ff5555 }
/* GenericEmph */ .chroma .ge { text-decoration: underline }
/* GenericError */ .chroma .gr { }
/* GenericHeading */ .chroma .gh { font-weight: bold }
/* GenericInserted */ .chroma .gi { font-weight: bold }
/* GenericInserted */ .chroma .gi { color: #50fa7b; font-weight: bold }
/* GenericOutput */ .chroma .go { color: #44475a }
/* GenericPrompt */ .chroma .gp { }
/* GenericStrong */ .chroma .gs { }
@@ -80,20 +83,3 @@
/* GenericTraceback */ .chroma .gt { }
/* GenericUnderline */ .chroma .gl { text-decoration: underline }
/* TextWhitespace */ .chroma .w { }
.lntd:first-of-type > .chroma {
padding-right: 0;
}
.chroma code {
font-family: 'Fira Code' !important;
font-size: 0.85em;
line-height: 1em;
background: none;
padding: 0;
}
.chroma {
border-radius: 3px;
margin: 0;
}

View File

@@ -0,0 +1,85 @@
/* Background */ .bg { color: #272822; background-color: #fafafa; }
/* PreWrapper */ .chroma { color: #272822; background-color: #fafafa; }
/* Other */ .chroma .x { }
/* Error */ .chroma .err { }
/* CodeLine */ .chroma .cl { }
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
/* LineHighlight */ .chroma .hl { background-color: #ffffcc }
/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
/* Line */ .chroma .line { display: flex; }
/* Keyword */ .chroma .k { color: #00a8c8 }
/* KeywordConstant */ .chroma .kc { color: #00a8c8 }
/* KeywordDeclaration */ .chroma .kd { color: #00a8c8 }
/* KeywordNamespace */ .chroma .kn { color: #f92672 }
/* KeywordPseudo */ .chroma .kp { color: #00a8c8 }
/* KeywordReserved */ .chroma .kr { color: #00a8c8 }
/* KeywordType */ .chroma .kt { color: #00a8c8 }
/* Name */ .chroma .n { color: #111111 }
/* NameAttribute */ .chroma .na { color: #75af00 }
/* NameBuiltin */ .chroma .nb { color: #111111 }
/* NameBuiltinPseudo */ .chroma .bp { color: #111111 }
/* NameClass */ .chroma .nc { color: #75af00 }
/* NameConstant */ .chroma .no { color: #00a8c8 }
/* NameDecorator */ .chroma .nd { color: #75af00 }
/* NameEntity */ .chroma .ni { color: #111111 }
/* NameException */ .chroma .ne { color: #75af00 }
/* NameFunction */ .chroma .nf { color: #75af00 }
/* NameFunctionMagic */ .chroma .fm { color: #111111 }
/* NameLabel */ .chroma .nl { color: #111111 }
/* NameNamespace */ .chroma .nn { color: #111111 }
/* NameOther */ .chroma .nx { color: #75af00 }
/* NameProperty */ .chroma .py { color: #111111 }
/* NameTag */ .chroma .nt { color: #f92672 }
/* NameVariable */ .chroma .nv { color: #111111 }
/* NameVariableClass */ .chroma .vc { color: #111111 }
/* NameVariableGlobal */ .chroma .vg { color: #111111 }
/* NameVariableInstance */ .chroma .vi { color: #111111 }
/* NameVariableMagic */ .chroma .vm { color: #111111 }
/* Literal */ .chroma .l { color: #ae81ff }
/* LiteralDate */ .chroma .ld { color: #d88200 }
/* LiteralString */ .chroma .s { color: #d88200 }
/* LiteralStringAffix */ .chroma .sa { color: #d88200 }
/* LiteralStringBacktick */ .chroma .sb { color: #d88200 }
/* LiteralStringChar */ .chroma .sc { color: #d88200 }
/* LiteralStringDelimiter */ .chroma .dl { color: #d88200 }
/* LiteralStringDoc */ .chroma .sd { color: #d88200 }
/* LiteralStringDouble */ .chroma .s2 { color: #d88200 }
/* LiteralStringEscape */ .chroma .se { color: #8045ff }
/* LiteralStringHeredoc */ .chroma .sh { color: #d88200 }
/* LiteralStringInterpol */ .chroma .si { color: #d88200 }
/* LiteralStringOther */ .chroma .sx { color: #d88200 }
/* LiteralStringRegex */ .chroma .sr { color: #d88200 }
/* LiteralStringSingle */ .chroma .s1 { color: #d88200 }
/* LiteralStringSymbol */ .chroma .ss { color: #d88200 }
/* LiteralNumber */ .chroma .m { color: #ae81ff }
/* LiteralNumberBin */ .chroma .mb { color: #ae81ff }
/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff }
/* LiteralNumberHex */ .chroma .mh { color: #ae81ff }
/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff }
/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff }
/* LiteralNumberOct */ .chroma .mo { color: #ae81ff }
/* Operator */ .chroma .o { color: #f92672 }
/* OperatorWord */ .chroma .ow { color: #f92672 }
/* Punctuation */ .chroma .p { color: #111111 }
/* Comment */ .chroma .c { color: #75715e }
/* CommentHashbang */ .chroma .ch { color: #75715e }
/* CommentMultiline */ .chroma .cm { color: #75715e }
/* CommentSingle */ .chroma .c1 { color: #75715e }
/* CommentSpecial */ .chroma .cs { color: #75715e }
/* CommentPreproc */ .chroma .cp { color: #75715e }
/* CommentPreprocFile */ .chroma .cpf { color: #75715e }
/* Generic */ .chroma .g { }
/* GenericDeleted */ .chroma .gd { }
/* GenericEmph */ .chroma .ge { font-style: italic }
/* GenericError */ .chroma .gr { }
/* GenericHeading */ .chroma .gh { }
/* GenericInserted */ .chroma .gi { }
/* GenericOutput */ .chroma .go { }
/* GenericPrompt */ .chroma .gp { }
/* GenericStrong */ .chroma .gs { font-weight: bold }
/* GenericSubheading */ .chroma .gu { }
/* GenericTraceback */ .chroma .gt { }
/* GenericUnderline */ .chroma .gl { }
/* TextWhitespace */ .chroma .w { }

View File

@@ -1,21 +1,65 @@
// Replace this with your own font imports!
@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;700&family=Inter:wght@400;600;700&family=Source+Sans+Pro:wght@400;600&display=swap');
:root {
--lt-colours-light: var(--light) !important;
--lt-colours-lightgray: var(--lightgray) !important;
--lt-colours-dark: var(--secondary) !important;
--lt-colours-secondary: var(--tertiary) !important;
--lt-colours-gray: var(--outlinegray) !important;
--font-body: "Source Sans Pro", sans-serif;
--font-header: "Inter", sans-serif;
--font-mono: "Fira Code", monospace;
}
h1, h2, h3, h4, ol, ul, thead {
font-family: Inter;
// typography
html {
scroll-behavior: smooth;
&:lang(ar) {
& p, & h1, & h2, & h3, article, header {
direction: rtl;
text-align: right;
}
}
& footer > p {
text-align: center !important;
}
}
.singlePage {
padding: 4em 30vw;
margin: 0 auto;
max-width: 1000px;
@media all and (max-width: 1200px) {
padding: 25px 5vw;
}
}
body {
margin: 0;
height: 100vh;
width: 100vw;
max-width: 100%;
box-sizing: border-box;
background-color: var(--light);
}
h1, h2, h3, h4, h5, h6, thead {
font-family: var(--font-header);
color: var(--dark);
font-weight: revert;
margin: revert;
padding: revert;
margin: 2rem 0 0;
padding: 2rem auto 1rem;
&:hover > .hanchor {
color: var(--secondary);
}
}
p, ul, text {
font-family: 'Source Sans Pro', sans-serif;
.hanchor {
font-family: var(--font-header);
opacity: 0.8;
transition: color 0.3s ease;
color: var(--dark);
}
p, ul, text, a, tr, td, li, ol, ul {
font-family: var(--font-body);
color: var(--gray);
fill: var(--gray);
font-weight: revert;
@@ -23,9 +67,31 @@ p, ul, text {
padding: revert;
}
tbody, li, p {
line-height: 1.5em;
}
.mainTOC {
border-radius: 5px;
padding: 0.75em 0;
& details {
& summary {
cursor: zoom-in;
font-family: var(--font-header);
color: var(--dark);
font-weight: 700;
}
&[open] summary {
cursor: zoom-out;
}
}
}
#TableOfContents > ol {
counter-reset: section;
margin-left: 0em;
margin-left: 0;
padding-left: 1.5em;
& > li {
counter-increment: section;
@@ -45,28 +111,30 @@ p, ul, text {
}
& > li::marker, & > li > ol > li::marker {
font-family: Source Sans Pro;
font-family: var(--font-body);
font-weight: 700;
}
}
footer {
margin-top: 4em;
text-align: center;
table {
border: 1px solid var(--outlinegray);
width: 100%;
padding: 1.5em;
border-collapse: collapse;
}
table {
width: 100%;
td, th {
padding: 0.2em 1em;
border: 1px solid var(--outlinegray);
}
img {
width: 100%;
max-width: 100%;
border-radius: 3px;
margin: 1em 0;
}
p>img+em {
p > img + em {
display: block;
transform: translateY(-1em);
}
@@ -75,33 +143,11 @@ sup {
line-height: 0
}
p, tbody, li {
font-family: Source Sans Pro;
color: var(--gray);
line-height: 1.5em;
}
h2, h3 {
opacity: 0.9;
}
blockquote {
margin-left: 0em;
margin-left: 0;
border-left: 3px solid var(--secondary);
padding-left: 1em;
transition: border-color 0.2s ease;
&:hover {
border-color: var(--tertiary);
}
}
table {
padding: 1.5em;
}
td, th {
padding: 0.1em 0.5em;
}
.footnotes p {
@@ -116,6 +162,10 @@ td, th {
gap: 1.5em;
justify-content: center;
.disabled {
opacity: 0.2;
}
& > li {
text-align: center;
display: inline-block;
@@ -124,59 +174,24 @@ td, th {
background-color: transparent !important;
}
& a[href$="#"] {
& a[href$="#"], &.active a {
opacity: 0.2;
}
}
}
.section {
& h3 > a {
font-weight: 700;
font-family: Inter;
margin: 0;
}
& p {
margin-top: 0;
}
}
article {
& > h1 {
margin-top: 2em;
font-size: 2em;
}
& > .meta {
margin: -1.5em 0 1em 0;
margin: 0 0 1em 0;
opacity: 0.7;
}
& > .tags {
list-style: none;
padding-left: 0;
& .meta {
& > h1 {
margin: 0;
}
& > p {
margin: 0;
}
}
& > li {
display: inline-block;
}
& > li > a {
border-radius: 8px;
border: var(--outlinegray) 1px solid;
padding: 0.2em 0.5em;
&::before {
content: "#";
margin-right: 0.3em;
color: var(--outlinegray);
}
}
}
& a {
font-family: Source Sans Pro;
font-weight: 600;
&.internal-link {
@@ -185,6 +200,46 @@ article {
padding: 0 0.1em;
margin: auto -0.1em;
border-radius: 3px;
&.broken {
opacity: 0.5;
background-color: transparent;
}
}
}
& p {
overflow-wrap: anywhere;
}
}
.tags {
list-style: none;
padding-left: 0;
& .meta {
margin: 1.5em 0;
& > h1 {
margin: 0;
}
& > p {
margin: 0;
}
}
& > li {
display: inline-block;
margin: 0.4em 0.2em;
}
& > li > a {
border-radius: 8px;
border: var(--outlinegray) 1px solid;
padding: 0.2em 0.5em;
&::before {
content: "#";
margin-right: 0.3em;
color: var(--outlinegray);
}
}
}
@@ -199,46 +254,39 @@ sup > a {
padding: 0 0.1em 0 0.2em;
}
#page-title {
margin: 0;
& > a {
font-family: var(--font-header);
}
}
a {
font-family: Inter, sans-serif;
font-size: 1em;
font-weight: 700;
text-decoration: none;
transition: all 0.2s ease;
color: var(--secondary);
&:hover {
color: var(--tertiary) !important;
}
}
pre {
font-family: 'Fira Code';
font-family: var(--font-mono);
padding: 0.75em;
border-radius: 3px;
overflow-x: scroll;
}
code {
font-family: 'Fira Code';
font-family: var(--font-mono);
font-size: 0.85em;
padding: 0.15em 0.3em;
border-radius: 5px;
background: var(--lightgray);
}
html {
scroll-behavior: smooth;
}
body {
margin: 0;
height: 100vh;
width: 100vw;
overflow-x: hidden;
background-color: var(--light);
}
@keyframes fadeIn {
0% {opacity:0;}
100% {opacity:1;}
@@ -246,30 +294,18 @@ body {
footer {
margin-top: 4em;
& > a {
font-size: 1em;
color: var(--secondary);
padding: 0 0.5em 3em 0.5em;
text-align: center;
& ul {
padding-left: 0;
}
}
hr {
width: 25%;
margin: 4em auto;
height: 2px;
border-radius: 1px;
border-width: 0;
color: var(--dark);
background-color: var(--dark);
}
.singlePage {
margin: 4em 30vw;
@media all and (max-width: 1200px) {
margin: 25px 5vw;
}
width: 100%;
margin: 2em auto;
height: 1px;
border: none;
background-color: var(--outlinegray);
}
.page-end {
@@ -288,7 +324,8 @@ hr {
& > .backlinks-container {
& > ul {
list-style: none;
padding-left: 0;
padding: 0;
margin: 0;
& > li {
margin: 0.5em 0;
@@ -302,6 +339,14 @@ hr {
& #graph-container {
border: var(--outlinegray) 1px solid;
border-radius: 5px;
box-sizing: border-box;
min-height: 250px;
margin: 0.5em 0;
& > svg {
margin-bottom: -5px;
}
}
}
@@ -309,14 +354,15 @@ hr {
margin-top: 30vh;
}
article > h1 {
font-size: 2em;
.spacer {
flex: 1 1 auto;
}
header {
display: flex;
flex-direction: row;
align-items: center;
margin: 1em 0 2em;
& > h1 {
font-size: 2em;
@@ -328,15 +374,24 @@ header {
}
}
& > .spacer {
flex: 1 1 auto;
#search-icon {
background-color: var(--lightgray);
border-radius: 4px;
height: 2em;
display: flex;
align-items: center;
cursor: pointer;
& > p {
display: inline;
padding: 0 1.5em 0 2em;
}
}
& > svg {
& svg {
cursor: pointer;
width: 18px;
min-width: 18px;
margin: 0 1em;
margin: 0 0.5em;
&:hover .search-path {
stroke: var(--tertiary);
@@ -383,7 +438,7 @@ header {
& > input {
box-sizing: border-box;
padding: 0.5em 1em;
font-family: Inter, sans-serif;
font-family: var(--font-body);
color: var(--dark);
font-size: 1.1em;
border: 1px solid var(--outlinegray);
@@ -394,7 +449,7 @@ header {
}
& > #results-container {
& > .result-card {
& .result-card {
padding: 1em;
cursor: pointer;
transition: background 0.2s ease;
@@ -431,66 +486,140 @@ header {
& > h3, & > p {
margin: 0;
}
& .search-highlight {
background-color: #afbfc966;
padding: 0.05em 0.2em;
border-radius: 3px;
}
}
}
}
}
.search-highlight {
background-color: #afbfc966;
padding: 0.05em 0.2em;
border-radius: 3px;
}
.section-ul {
list-style: none;
margin-top: 2em;
padding-left: 0;
& > li {
border: 1px solid var(--outlinegray);
border-radius: 5px;
padding: 0 1em;
margin-bottom: 1em;
}
& h3 {
opacity: 1;
.section-li {
margin-bottom: 1em;
& > .section {
display: flex;
align-items: center;
@media all and (max-width: 600px) {
& .tags {
display: none;
}
}
& h3 > a {
font-weight: 700;
margin-bottom: 0em;
margin: 0;
}
& .meta {
opacity: 0.6;
& p {
margin: 0;
padding-right: 1em;
flex-basis: 6em;
}
}
& h3 {
opacity: 1;
font-weight: 700;
margin: 0;
}
& .meta {
opacity: 0.6;
}
}
@keyframes dropin {
0% {
display: none;
opacity: 0;
visibility: hidden;
}
1% {
display: inline-block;
opacity: 0;
}
100% {
opacity: 1;
visibility: visible;
}
}
.popover {
z-index: 999;
position: absolute;
width: 15em;
display: inline;
width: 20rem;
display: none;
background-color: var(--light);
padding: 1em;
padding: 1rem;
margin: 1rem;
border: 1px solid var(--outlinegray);
border-radius: 5px;
transform: translate(-50%, 40%);
opacity: 0;
pointer-events: none;
transition: opacity 0.2s ease, transform 0.2s ease;
transition-delay: 0.3s;
user-select: none;
overflow-wrap: anywhere;
box-shadow: 6px 6px 36px 0 rgba(0,0,0,0.25);
@media all and (max-width: 600px) {
display: none !important;
}
&.visible {
opacity: 1;
transform: translate(-50%, 20%);
visibility: visible;
display: inline-block;
animation: dropin 0.2s ease;
}
& > h3 {
margin: 0.5em 0;
font-size: 1rem;
margin: 0.25rem 0;
}
& .meta {
margin-top: 0.25rem;
opacity: 0.5;
font-family: var(--font-mono);
font-size: 0.8rem;
}
& > p {
margin: 0;
padding: 0.5rem 0;
}
& > p, & > a {
font-size: 1rem;
font-weight: 400;
user-select: none;
}
}
#contact_buttons ul {
list-style-type: none;
li {
display: inline-block;
}
li a {
padding: 0 1em;
}
}
mark {
background-color: var(--highlighted);
color: var(--gray);
}

View File

@@ -0,0 +1,47 @@
.clipboard-button {
position: absolute;
display: flex;
float: right;
right: 0;
padding: 0.69em;
margin: 0.5em;
color: var(--outlinegray);
border-color: var(--dark);
background-color: var(--lightgray);
filter: contrast(1.1);
border: 2px solid;
border-radius: 6px;
font-size: 0.8em;
z-index: 1;
opacity: 0;
transition: 0.12s;
& > svg {
fill: var(--light);
filter: contrast(0.3);
}
&:hover {
cursor: pointer;
border-color: var(--primary);
& > svg {
fill: var(--primary);
}
}
&:focus {
outline: 0;
}
}
.highlight {
position: relative;
&:hover > .clipboard-button {
opacity: 1;
transition: 0.2s;
}
}

View File

@@ -0,0 +1,20 @@
.code-title {
color: var(--primary) ;
font-family: var(--font-mono);
width: max-content;
overflow-x: auto;
display: inline-block;
vertical-align: middle;
font-weight: normal;
line-height: 1em;
position: relative;
padding: 0.5em 0.6em 0.6em; // + 1.2 em
max-width: calc(100% - 1.2em); // (-1.2 em) fits article width exactly
margin-bottom: -0.2em;
z-index: -1;
border-top-left-radius: 0.3em;
border-top-right-radius: 0.3em;
font-size: 0.9em;
background-color: var(--lightgray);
filter: hue-rotate(-30deg) contrast(1.0) opacity(0.8);
}

View File

@@ -1,4 +1,5 @@
// Add your own CSS here!
:root {
--light: #faf8f8;
--dark: #141021;
@@ -9,6 +10,8 @@
--gray: #4e4e4e;
--lightgray: #f0f0f0;
--outlinegray: #dadada;
--million-progress-bar-color: var(--secondary);
--highlighted: #f5dfaf88;
}
[saved-theme="dark"] {
@@ -21,4 +24,8 @@
--gray: #d4d4d4 !important;
--lightgray: #292633 !important;
--outlinegray: #343434 !important;
}
--highlighted: #574010;
}

66
assets/styles/syntax.scss Normal file
View File

@@ -0,0 +1,66 @@
// Overrides
/* Background */
.chroma {
overflow: hidden !important;
background-color: var(--lightgray) !important;
}
/* LineTable */
.chroma .lntable {
width: auto !important;
overflow: auto !important;
display: block !important;
}
/* LineHighlight */
.chroma .hl {
display: block !important;
width: 100% !important;
}
/* LineNumbersTable */
.chroma .lnt {
margin-right: 0.0em !important;
padding: 0 0.0em 0 0.0em !important;
}
/* LineNumbers */
.chroma .ln {
margin-right: 0.0em !important;
padding: 0 0.0em 0 0.0em !important;
}
/* GenericDeleted */
.chroma .gd {
color: #8b080b !important;
}
/* GenericInserted */
.chroma .gi {
font-weight: bold !important;
}
.lntd:first-of-type > .chroma {
padding-right: 0 !important;
}
.chroma code {
font-family: var(--font-mono) !important;
font-size: 0.85em !important;
line-height: 2em !important;
background: none !important;
padding: 0 !important;
}
.chroma {
border-radius: 3px !important;
margin: 0 !important;
}
pre.chroma {
-moz-tab-size:4;-o-tab-size:4;tab-size:4;
}
.katex {
font-size: 1.1em !important;
}

View File

@@ -1,7 +1,5 @@
baseURL = "https://quartz.jzhao.xyz/"
baseURL = "https://three.quartz.jzhao.xyz/"
languageCode = "en-us"
googleAnalytics = "G-XYFD95KB4J"
pygmentsUseClasses = true
relativeURLs = false
disablePathToLower = true
ignoreFiles = [
@@ -18,6 +16,7 @@ enableGitInfo = true
ordered = true
startLevel = 2
[markup.highlight]
noClasses = false
anchorLineNos = false
codeFences = true
guessSyntax = true
@@ -27,4 +26,8 @@ enableGitInfo = true
lineNos = true
lineNumbersInTable = true
style = "dracula"
tabWidth = 4
[frontmatter]
lastmod = ["lastmod", ":git", "date", "publishDate"]
publishDate = ["publishDate", "date"]
[markup.goldmark.renderer]
unsafe = true

View File

@@ -1,25 +1,27 @@
---
title: 🪴 Quartz 3
title: 🪴 Quartz 3.3
enableToc: false
---
Host your second brain and [digital garden](https://jzhao.xyz/posts/digital-gardening) for free. Quartz features
1. Extremely fast full-text search by pressing `/`
2. Display for backlinks of each note
3. Fully customizable local graph view
4. Endlessly powerful page and theme customization using CSS
5. Automatically generated tag and section lists of content
6. Beautiful link previews
Host your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features
1. Extremely fast natural-language [[notes/search]]
2. Customizable and hackable design based on [Hugo](https://gohugo.io/)
3. Automatically generated backlinks, link previews, and local graph
4. Built-in [[notes/CJK + Latex Support (测试) | CJK + Latex Support]] and [[notes/callouts | Admonition-style callouts]]
5. Support for both Markdown Links and Wikilinks
Check out some of the [amazing gardens that community members](notes/showcase.md) have published with Quartz or read about [why I made Quartz](notes/philosophy.md) to begin with.
## Get Started
> 📚 [Setup your own digital garden using Quartz](notes/setup.md)
> 📚 Step 1: [Setup your own digital garden using Quartz](notes/setup.md)
Not convinced yet? Look at some [community digital gardens](moc/showcase) built with Quartz, or read about [why I made Quartz](notes/philosophy.md) to begin with!
Returning user? Figure out how to [[notes/updating|update]] your existing Quartz garden.
## Content Lists
If you prefer browsing the contents of this site through a list instead of a graph, you can find content lists here too:
If you prefer browsing the contents of this site through a list instead of a graph, you see a list of all [setup-related notes](/tags/setup).
- [All Notes](/notes)
- [Setup-related Notes](/tags/setup)
## Troubleshooting
### Troubleshooting
- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)
- 🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)
- 👀 [Discord Community](https://discord.gg/cRFFHYye7t)

View File

@@ -1,16 +0,0 @@
---
title: "Showcase"
---
Want to see what Quartz can do? Here are some cool community gardens :)
- [Quartz Documentation (this site!)](https://quartz.jzhao.xyz/)
- [Strengthening Online Social Bonds: Research Garden](https://communities.digital/)
- [Jacky Zhao's Garden](https://garden.jzhao.xyz/)
- [Anson Yu's Garden](http://garden.ansonyu.me/)
- [Shihyu's PKM](https://shihyuho.github.io/pkm/)
- [Chloe's Garden](https://garden.chloeabrasada.online/)
- [SlRvb's Site](https://slrvb.github.io/Site/)
- [Course notes for Information Technology Advanced Theory](https://a2itnotes.github.io/quartz/)
If you want to see your own on here, submit a [Pull Request adding yourself to this file](https://github.com/jackyzha0/quartz/blob/hugo/content/moc/showcase.md)!

View File

@@ -0,0 +1,40 @@
---
title: "CJK + Latex Support (测试)"
---
## Chinese, Japanese, Korean Support
几乎在我们意识到之前,我们已经离开了地面。
우리가 그것을 알기도 전에 우리는 땅을 떠났습니다.
私たちがそれを知るほぼ前に、私たちは地面を離れていました。
## Latex
Block math works with two dollar signs `$$...$$`
$$f(x) = \int_{-\infty}^\infty
f\hat(\xi),e^{2 \pi i \xi x}
\,d\xi$$
Inline math also works with single dollar signs `$...$`. For example, Euler's identity but inline: $e^{i\pi} = -1$
Aligned equations work quite well:
$$
\begin{aligned}
a &= b + c \\ &= e + f \\
\end{aligned}
$$
And matrices
$$
\begin{bmatrix}
1 & 2 & 3 \\
a & b & c
\end{bmatrix}
$$
## RTL
More information on configuring RTL languages like Arabic in the [config](notes/config.md) page.

View File

@@ -1,28 +0,0 @@
---
title: "Obsidian Vault Integration"
tags:
- setup
---
## Setup
Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.
### New Vault
If you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](notes/setup.md).
### Linking an existing Vault
The easiest way to use an existing Vault is to copy all of our files (directory and hierarchies intact) into the `/content` folder.
## Settings
Great, now that you have your Obsidian linked to your Quartz, let's fix some settings so that they play well.
Under Options > Files and Links, set the New link format to always be Absolute Path in Vault and disabled WikiLinks so Obsidian generates regular Markdown links.
![Obsidian Settings](/notes/images/obsidian-settings.png)*Obsidian Settings*
## Templates
Inserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.
**If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!**
Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for 'Insert Template'. That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!

63
content/notes/callouts.md Normal file
View File

@@ -0,0 +1,63 @@
---
title: "Callouts"
---
## Callout support
Quartz supports the same Admonition-callout syntax as Obsidian.
This includes
- 12 Distinct callout types (each with several aliases)
- Collapsable callouts
See [documentation on supported types and syntax here](https://help.obsidian.md/Editing+and+formatting/Callouts).
## Showcase
> [!EXAMPLE] Examples
>
> Aliases: example
> [!note] Notes
>
> Aliases: note
> [!abstract] Summaries
>
> Aliases: abstract, summary, tldr
> [!info] Info
>
> Aliases: info, todo
> [!tip] Hint
>
> Aliases: tip, hint, important
> [!success] Success
>
> Aliases: success, check, done
> [!question] Question
>
> Aliases: question, help, faq
> [!warning] Warning
>
> Aliases: warning, caution, attention
> [!failure] Failure
>
> Aliases: failure, fail, missing
> [!danger] Error
>
> Aliases: danger, error
> [!bug] Bug
>
> Aliases: bug
> [!quote] Quote
>
> Aliases: quote, cite

View File

@@ -2,47 +2,227 @@
title: "Configuration"
tags:
- setup
weight: 0
---
## Configuration
Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you'd like to get.
The majority of configuration can be be found under `data/config.yaml`. An annotated example configuration is shown below.
The majority of configuration can be found under `data/config.yaml`. An annotated example configuration is shown below.
```yaml
name: Your name here! # Shows in the footer
enableToc: true # Whether to show a Table of Contents
description: Page description to show to search engines
page_title: Quartz Example Page # Default Page Title
```yaml {title="data/config.yaml"}
# The name to display in the footer
name: Jacky Zhao
links: # Links to show in footer
# whether to globally show the table of contents on each page
# this can be turned off on a per-page basis by adding this to the
# front-matter of that note
enableToc: true
# whether to by-default open or close the table of contents on each page
openToc: false
# whether to display on-hover link preview cards
enableLinkPreview: true
# whether to render titles for code blocks
enableCodeBlockTitle: true
# whether to render copy buttons for code blocks
enableCodeBlockCopy: true
# whether to render callouts
enableCallouts: true
# whether to try to process Latex
enableLatex: true
# whether to enable single-page-app style rendering
# this prevents flashes of unstyled content and improves
# smoothness of Quartz. More info in issue #109 on GitHub
enableSPA: true
# whether to render a footer
enableFooter: true
# whether backlinks of pages should show the context in which
# they were mentioned
enableContextualBacklinks: true
# whether to show a section of recent notes on the home page
enableRecentNotes: false
# whether to display an 'edit' button next to the last edited field
# that links to github
enableGitHubEdit: true
GitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content
# whether to render mermaid diagrams
enableMermaid: true
# whether to use Operand to power semantic search
# IMPORTANT: replace this API key with your own if you plan on using
# Operand search!
search:
enableSemanticSearch: false
operandApiKey: "REPLACE-WITH-YOUR-OPERAND-API-KEY"
operandIndexId: "REPLACE-WITH-YOUR-OPERAND-INDEX-ID"
# page description used for SEO
description:
Host your second brain and digital garden for free. Quartz features extremely fast full-text search,
Wikilink support, backlinks, local graph, tags, and link previews.
# title of the home page (also for SEO)
page_title:
"🪴 Quartz 3.3"
# links to show in the footer
links:
- link_name: Twitter
link: https://twitter.com/_jzhao
- link_name: Github
link: https://github.com/jackyzha0
```
### Code Block Titles
To add code block titles with Quartz:
1. Ensure that code block titles are enabled in Quartz's configuration:
```yaml {title="data/config.yaml", linenos=false}
enableCodeBlockTitle: true
```
2. Add the `title` attribute to the desired [code block
fence](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences):
```markdown {linenos=false}
```yaml {title="data/config.yaml"}
enableCodeBlockTitle: true # example from step 1
```
```
**Note** that if `{title=<my-title>}` is included, and code block titles are not
enabled, no errors will occur, and the title attribute will be ignored.
### HTML Favicons
If you would like to customize the favicons of your Quartz-based website, you
can add them to the `data/config.yaml` file. The **default** without any set
`favicon` key is:
```html {title="layouts/partials/head.html", linenostart=15}
<link rel="shortcut icon" href="icon.png" type="image/png">
```
The default can be overridden by defining a value to the `favicon` key in your
`data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is
equivalent to the default:
```yaml {title="data/config.yaml", linenos=false}
favicon:
- { rel: "shortcut icon", href: "icon.png", type: "image/png" }
# - { ... } # Repeat for each additional favicon you want to add
```
In this format, the keys are identical to their HTML representations.
If you plan to add multiple favicons generated by a website (see list below), it
may be easier to define it as HTML. Here is an example which appends the
**Apple touch icon** to Quartz's default favicon:
```yaml {title="data/config.yaml", linenos=false}
favicon: |
<link rel="shortcut icon" href="icon.png" type="image/png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
```
This second favicon will now be used as a web page icon when someone adds your
webpage to the home screen of their Apple device. If you are interested in more
information about the current and past standards of favicons, you can read
[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/).
**Note** that all generated favicon paths, defined by the `href`
attribute, are relative to the `static/` directory.
### Graph View
To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`.
```yaml
enableLegend: false # automatically generate a legend
enableDrag: true # allow dragging nodes in the graph
enableZoom: true # allow zooming and panning the graph
depth: -1 # how many neighbours of the current node to show (-1 is all nodes)
paths: # colour specific nodes path off of their path
```yaml {title="data/graphConfig.yaml"}
# if true, a Global Graph will be shown on home page with full width, no backlink.
# A different set of Local Graphs will be shown on sub pages.
# if false, Local Graph will be default on every page as usual
enableGlobalGraph: false
### Local Graph ###
localGraph:
# whether automatically generate a legend
enableLegend: false
# whether to allow dragging nodes in the graph
enableDrag: true
# whether to allow zooming and panning the graph
enableZoom: true
# how many neighbours of the current node to show (-1 is all nodes)
depth: 1
# initial zoom factor of the graph
scale: 1.2
# how strongly nodes should repel each other
repelForce: 2
# how strongly should nodes be attracted to the center of gravity
centerForce: 1
# what the default link length should be
linkDistance: 1
# how big the node labels should be
fontSize: 0.6
# scale at which to start fading the labes on nodes
opacityScale: 3
### Global Graph ###
globalGraph:
# same settings as above
### For all graphs ###
# colour specific nodes path off of their path
paths:
- /moc: "#4388cc"
```
## Styling
Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`.
Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/styles/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`.
### Partials
Partials are what dictate what actually gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`.
Partials are what dictate what gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`.
For example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html`
More info about partials on [Hugo's website.](https://gohugo.io/templates/partials/)
Still having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
Still having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
## Language Support
[CJK + Latex Support (测试)](notes/CJK%20+%20Latex%20Support%20(测试).md) comes out of the box with Quartz.
Want to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively.
Follow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.toml`
For example:
```toml
defaultContentLanguage = 'ar'
[languages]
[languages.ar]
languagedirection = 'rtl'
title = 'مدونتي'
weight = 1
```

View File

@@ -0,0 +1,17 @@
---
title: "Custom Domain"
---
### Registrar
This step is only applicable if you are using a **custom domain**! If you are using a `<YOUR-USERNAME>.github.io` domain, you can skip this step.
For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).
GitHub has some [documentation on this](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), but the tldr; is to
1. Go to your forked repository (`github.com/<YOUR-GITHUB-USERNAME>/quartz`) settings page and go to the Pages tab. Under "Custom domain", type your custom domain, then click **Save**.
2. Go to your DNS Provider and create a CNAME record that points from your domain to `<YOUR-GITHUB-USERNAME.github.io.` (yes, with the trailing period).
![Example Configuration for Quartz](/notes/images/google-domains.png)*Example Configuration for Quartz*
3. Wait 30 minutes to an hour for the network changes to kick in.
4. Done!

57
content/notes/docker.md Normal file
View File

@@ -0,0 +1,57 @@
---
title: "Hosting with Docker"
tags:
- setup
---
If you want to host Quartz on a machine without using a webpage hosting service, it may be easier to [install Docker Compose](https://docs.docker.com/compose/install/) and follow the instructions below than to [install Quartz's dependencies manually](notes/preview%20changes.md).
## Hosting Quartz Locally
You can serve Quartz locally at `http://localhost:1313` with the following script, replacing `/path/to/quartz` with the
actual path to your Quartz folder.
docker-compose.yml
```
services:
quartz-hugo:
image: ghcr.io/jackyzha0/quartz:hugo
container_name: quartz-hugo
volumes:
- /path/to/quartz:/quartz
ports:
- 1313:1313
# optional
environment:
- HUGO_BIND=0.0.0.0
- HUGO_BASEURL=http://localhost
- HUGO_PORT=1313
- HUGO_APPENDPORT=true
- HUGO_LIVERELOADPORT=-1
```
Then run with: `docker-compose up -d` in the same directory as your `docker-compose.yml` file.
While the container is running, you can update the `quartz` fork with: `docker exec -it quartz-hugo make update`.
## Exposing Your Container to the Internet
### To Your Public IP Address with Port Forwarding (insecure)
Assuming you are already familiar with [port forwarding](https://en.wikipedia.org/wiki/Port_forwarding) and [setting it up with your router model](https://portforward.com):
1. You should set the environment variable `HUGO_BASEURL=http://your-public-ip` and then start your container.
2. Set up port forwarding on your router from port `p` to `your-local-ip:1313`.
3. You should now be able to access Quartz from outside your local network at `http://your-public-ip:p`.
However, your HTTP connection will be unencrypted and **this method is not secure**.
### To a Domain using Cloudflare Proxy
1. Port forward 443 (HTTPS) from your machine.
2. Buy a custom domain (say, `your-domain.com`) from [Cloudflare](https://www.cloudflare.com/products/registrar/). Point a DNS A record from `your-domain.com` to your public IP address and enable the proxy.
3. Set the environment variables `HUGO_BASEURL=https://your-domain.com`, `HUGO_PORT=443`, and `HUGO_APPENDPORT=false`. Change `1313:1313` to `443:443` for the `ports` in `docker-compose.yml`.
4. Spin up your Quartz container and enjoy it at `https://your-domain.com`!
### To a Domain using a Reverse Proxy
If you want to serve more than just Quartz to the internet on this machine (or don't want to use the Cloudflare registrar and proxy), you should follow the steps in the section above (as appropriate) and also set up a reverse proxy, like [Traefik](https://doc.traefik.io/traefik). Be sure to configure your TLS certificates too!

View File

@@ -2,58 +2,51 @@
title: "Editing Content in Quartz"
tags:
- setup
weight: -4
---
## Editing
Quartz runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).
### Obsidian
I *strongly* recommend using [Obsidian](http://obsidian.md/) as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of my local files.
🔗 How to link your Obsidian Vault](notes/Obsidian.md)
Of course, all the files are in Markdown so you could just use your favourite text editor of choice.
### Ignoring Files
Only want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process.
❌ [Excluding pages from being published](notes/ignore%20notes.md)
### Folder Structure
Here's a rough overview of what's what.
**All content in your garden can found in the `/content` folder.** To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you'd like.
**To edit the main home page, open `/content/_index.md`.** This is the home page which is slightly special. You don't need front matter here!
To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that **all links should be relative to the root `/content` path**.
```markdown
For example, I want to link this current document to `notes/config.md`.
[A link to the config page](notes/config.md)
```
**To edit the main home page, open `/content/_index.md`.**
### Front Matter
Hugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file like so:
Hugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file like so, otherwise the generated page will not have a title!
```markdown
You can also add tags here as well.
```yaml
---
title: "Example Title"
tags:
- example-tag
---
Rest of your content here...
```
## Previewing Changes
This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended*.
### Obsidian
I recommend using [Obsidian](http://obsidian.md/) as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of your local files.
👀 [Preview Quartz Changes](notes/preview%20changes.md)
This step is **highly recommended**.
> 🔗 Step 3: [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md)
## Previewing Changes
This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended* but not required.
> 👀 Step 4: [Preview Quartz Changes](notes/preview%20changes.md)
For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
## Publishing Changes
Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!
🌍 [Hosting Quartz online!](notes/hosting.md)
> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md)
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).

View File

@@ -2,27 +2,33 @@
title: "Deploying Quartz to the Web"
tags:
- setup
weight: -1
aliases:
- hosting
---
## GitHub Pages
Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! You can head to `<YOUR-GITHUB-USERNAME.github.io/quartz` to see it live.
## Hosting on GitHub Pages
Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below.
### Enable GitHub Actions
By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
### Enable GitHub Actions Permissions
By default, GitHub disables workflows from modifying your files (for good reason!). However, Quartz needs this to write the actual site files back to GitHub.
![Enable GitHub Actions](/notes/images/github-actions.png)*Enable GitHub Actions*
Head to `Settings > Action > General > Workflow Permissions` and choose `Read and Write Permissions`
![[notes/images/github-actions.png]]
*Enable GitHub Actions*
### Enable GitHub Pages
Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab.
1. Set the source to deploy from `master` using `/ (root)`
1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)`
2. Set a custom domain here if you have one!
![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages*
### Pushing Changes
To see your changes on the internet, we need to push it them to GitHub. Quartz is essentially a `git` repository so updating it is the same workflow as you would follow as normal.
To see your changes on the internet, we need to push it them to GitHub. Quartz is a `git` repository so updating it is the same workflow as you would follow as if it were just a regular software project.
```shell
# Navigate to Quartz folder
@@ -36,10 +42,14 @@ git commit -m "message describing changes"
git push origin hugo
```
Note: we specifically push to the `hugo` branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the `master` branch for redeployment.
### Setting up the Site
Now let's get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to subdomain your Quartz? That's easy too.
Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`. If you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io` (which GitHub gives to you for free!) as your domain.
Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`.
Make sure that your `baseURL` has a trailing `/`!
[Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml)
@@ -47,7 +57,7 @@ Here, we take advantage of GitHub's free page hosting to deploy our site. Change
baseURL = "https://<YOUR-DOMAIN>/"
```
If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing path.
If you are using this under a subdomain (e.g. `<YOUR-GITHUB-USERNAME>.github.io/quartz`), include the trailing `/`. **You need to do this especially if you are using GitHub!**
```toml
baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/"
@@ -55,9 +65,11 @@ baseURL = "https://<YOUR-GITHUB-USERNAME>.github.io/quartz/"
Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `<YOUR-USERNAME>.github.io`.
Please note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`.
[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)
```yaml
```yaml {title=".github/workflows/deploy.yaml"}
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
@@ -67,27 +79,21 @@ Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a c
cname: <YOUR-DOMAIN>
```
### Registrar
This step is only applicable if you are using a **custom domain**! If you are using `<YOUR-USERNAME>.github.io`, you can skip this step.
Have a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md).
For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains).
### Ignoring Files
Only want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process.
GitHub has some [documentation on this](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), but the tldr; is to
❌ [Excluding pages from being published](notes/ignore%20notes.md)
1. Go to your forked repository (`github.com/<YOUR-GITHUB-USERNAME>/quartz`) settings page and go to the Pages tab. Under "Custom domain", type your custom domain, then click **Save**.
2. Go to your DNS Provider and create a CNAME record that points from your domain to `<YOUR-GITHUB-USERNAME.github.io.` (yes, with the trailing period).
![Example Configuration for Quartz](/notes/images/google-domains.png)*Example Configuration for Quartz*
3. Wait 30 minutes to an hour for the network changes to kick in.
4. Done!
## External Hosting
Don't want to use GitHub Pages? Hugo builds everything for you! Everything is a packaged set of static files ready to deploy in `/public`. You can then upload this folder to a cloud provider to deploy. Alternatively, most providers also give users the option to link a GitHub repository and a folder to deploy. When doing this, ensure you select `/public` folder under the `master` branch.
## Docker Support
If you don't want to use a hosting service, you can host using [Docker](notes/docker.md) instead!
I would *not use this method* unless you know what you are doing.
---
Now that your Quartz is live, let's figure out how to make Quartz really *yours*!
🎨 [Customizing Quartz](notes/config.md)
> Step 6: 🎨 [Customizing Quartz](notes/config.md)
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

@@ -2,27 +2,36 @@
title: "Obsidian Vault Integration"
tags:
- setup
weight: -3
---
## Setup
Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.
### New Vault
If you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](notes/setup.md).
If you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](notes/setup.md) step.
### Linking an existing Vault
The easiest way to use an existing Vault is to copy all of our files (directory and hierarchies intact) into the `/content` folder.
The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder.
## Settings
Great, now that you have your Obsidian linked to your Quartz, let's fix some settings so that they play well.
Under Options > Files and Links, set the New link format to always be Absolute Path in Vault and disabled WikiLinks so Obsidian generates regular Markdown links.
Open Settings > Files & Links and look for these two items:
![Obsidian Settings](/notes/images/obsidian-settings.png)*Obsidian Settings*
1. Set the **New link format** to **Absolute Path in vault**. If you have a completely flat vault (no folders), this step isn't necessary.
2. Turn **on** the **Automatically update internal links** setting.
![[notes/images/obsidian-settings.png]]*Obsidian Settings*
## Templates
Inserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily.
**If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!**
> [!WARNING]
>
> **If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!**
Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for 'Insert Template'. That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!
Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for 'Insert Template' (I recommend `[cmd]+T`). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go!
> 👀 Step 4: [Preview Quartz Changes](notes/preview%20changes.md)

View File

@@ -1,34 +1,41 @@
---
title: "Preview Changes"
tags:
- setup
weight: -2
---
If you'd like to preview what your Quartz site looks like before deploying it to the internet, here's exactly how to do that!
If you'd like to preview what your Quartz site looks like before deploying it to the internet, the following
instructions guide you through installing the proper dependencies to run it locally.
## Install `hugo-obsidian`
This step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (>= 1.16) installed.
```shell
```bash
# Install and link `hugo-obsidian` locally
$ go install github.com/jackyzha0/hugo-obsidian
# Navigate to your local Quartz folder
$ cd <location-of-your-local-quartz>
# Scrape all links in your Quartz folder and generate info for Quartz
$ hugo-obsidian -input=content -output=data -index=true
go install github.com/jackyzha0/hugo-obsidian@latest
```
Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!
If you are running into an error saying that `command not found: hugo-obsidian`, make sure you set your `GOPATH` correctly (see [[notes/troubleshooting#`command not found: hugo-obsidian`|the troubleshooting page]])! This will allow your terminal to correctly recognize hugo-obsidian as an executable.
## Installing Hugo
Hugo is the static site generator that powers Quartz. If you'd like to preview your site locally, [install Hugo](https://gohugo.io/getting-started/installing/).
Hugo is the static site generator that powers Quartz. [Install Hugo with "extended" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then,
```
```bash
# Navigate to your local Quartz folder
$ cd <location-of-your-local-quartz>
cd <location-of-your-local-quartz>
# Start local server
$ hugo server
make serve
# View your site in a browser at http://localhost:1313/
```
```
> [!INFO] Docker Support
>
> If you have the Docker CLI installed already, you can avoid installing `hugo-obsidian` and `hugo`. Instead, open your terminal, navigate to your folder with Quartz and run `make docker`
Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated! Now, let's get it hosted online.
> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md)

37
content/notes/search.md Normal file
View File

@@ -0,0 +1,37 @@
---
title: "Search"
---
Quartz supports two modes of searching through content.
## Full-text
Full-text search is the default in Quartz. It produces results that *exactly* match the search query. This is easier to setup but usually produces lower quality matches.
```yaml {title="data/config.yaml"}
# the default option
enableSemanticSearch: false
```
## Natural Language
Natural language search is powered by [Operand](https://beta.operand.ai/). It understands language like a person does and finds results that best match user intent. In this sense, it is closer to how Google Search works.
Natural language search tends to produce higher quality results than full-text search.
Here's how to set it up.
1. Login or Register for a new Operand account. Click the verification link sent to your email, and you'll be redirected to the dashboard. (Note) You do not need to enter a credit card to create an account, or get started with the Operand API. The first $10 of usage each month is free. To learn more, see pricing. If you go over your free quota, we'll (politely) reach out and ask you to configure billing.
2. Create your first index. On the dashboard, under "Indexes", enter the name and description of your index, and click "Create Index". Note down the ID of the index (obtained by clicking on the index name in the list of indexes), as you'll need it in the next step. IDs are unique to each index, and look something like `uqv1duxxbdxu`.
3. Click into the index you've created. Under "Index Something", select "SITEMAP" from the dropdown and click "Add Source".
4. For the "Sitemap.xml URL", put your deployed site's base URL followed by `sitemap.xml`. For example, for `quartz.jzhao.xyz`, put `https://quartz.jzhao.xyz/sitemap.xml`. Leave the URL Regex empty.
5. Get your API key. On the dashboard, under "API Keys", you can manage your API keys. If you don't already have an API key, click "Create API Key". You'll need this for the next step.
6. Open `data/config.yaml`. Set `enableSemanticSearch` to `true`, `operandApiKey` to your copied key, and `operandIndexId` to the ID of the index we created from earlier..
```yaml {title="data/config.yaml"}
# the default option
search:
enableSemanticSearch: true
operandApiKey: "jp9k5hudse2a828z98kxd6z3payi8u90rnjf"
operandIndexId: "s0kf3bd6tldw"
```
7. Push your changes to the site and wait for it to deploy.
8. Check the Operand dashboard and wait for your site to index. Enjoy natural language search powered by Operand!

View File

@@ -2,6 +2,7 @@
title: "Setup"
tags:
- setup
weight: -5
---
## Making your own Quartz
@@ -14,18 +15,22 @@ Navigate to the GitHub repository for the Quartz project:
📁 [Quartz Repository](https://github.com/jackyzha0/quartz)
Then, Fork the repository into your own GitHub account. If you don't have an account, you can make on for free [here](https://github.com/join). More details about forking a repo can be found on [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
Then, Fork the repository into your own GitHub account. **Make sure that when you fork, you _uncheck_ the 'Copy the `hugo` branch only' option**.
If you don't have an account, you can make on for free [here](https://github.com/join). More details about forking a repo can be found on [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
![[notes/images/fork.png]]
### Cloning
After you've made a fork of the repository, you need to download the files locally onto your machine. Ensure you have `git`, then type the following command replacing `YOUR-USERNAME` with your GitHub username.
After you've made a fork of the repository, you need to download the files locally onto your machine. Ensure you have `git`, then type the following command in your terminal replacing `YOUR-USERNAME` with your GitHub username.
```shell
$ git clone https://github.com/YOUR-USERNAME/quartz
git clone https://github.com/YOUR-USERNAME/quartz
```
## Editing
Great! Now you have everything you need to start editing and growing your digital garden. If you're ready to start writing content already, check out the recommended flow for editing notes in Quartz.
✏️ [Editing Notes in Quartz](notes/editing.md)
> ✏️ Step 2: [Editing Notes in Quartz](notes/editing.md)
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).

23
content/notes/showcase.md Normal file
View File

@@ -0,0 +1,23 @@
---
title: "Showcase"
---
Want to see what Quartz can do? Here are some cool community gardens :)
- [Quartz Documentation (this site!)](https://quartz.jzhao.xyz/)
- [Jacky Zhao's Garden](https://jzhao.xyz/)
- [Scaling Synthesis - A hypertext research notebook](https://scalingsynthesis.com/)
- [AWAGMI Intern Notes](https://notes.awagmi.xyz/)
- [Shihyu's PKM](https://shihyuho.github.io/pkm/)
- [SlRvb's Site](https://slrvb.github.io/Site/)
- [Course notes for Information Technology Advanced Theory](https://a2itnotes.github.io/quartz/)
- [Brandon Boswell's Garden](https://brandonkboswell.com)
- [Siyang's Courtyard](https://siyangsun.github.io/courtyard/)
- [Data Dictionary 🧠](https://glossary.airbyte.com/)
- [sspaeti.com's Second Brain](https://brain.sspaeti.com/)
- [oldwinterの数字花园](https://garden.oldwinter.top/)
- [SethMB Work](https://sethmb.xyz/)
- [Abhijeet's Math Wiki](https://abhmul.github.io/quartz/Math-Wiki/)
- [Mike's AI Garden 🤖🪴](https://mwalton.me/)
If you want to see your own on here, submit a [Pull Request adding yourself to this file](https://github.com/jackyzha0/quartz/blob/hugo/content/notes/showcase.md)!

View File

@@ -2,7 +2,21 @@
title: "Troubleshooting and FAQ"
---
## Common Pitfalls
Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.
While you're here, join our [Discord](https://discord.gg/cRFFHYye7t) :)
### Does Quartz have Latex support?
Yes! See [CJK + Latex Support (测试)](notes/CJK%20+%20Latex%20Support%20(测试).md) for a brief demo.
### Can I use \<Obsidian Plugin\> in Quartz?
Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz.
The easiest way would be to add your own HTML partial that supports the functionality you are looking for.
### My GitHub pages is just showing the README and not Quartz
Make sure you set the source to deploy from `master` (and not `hugo`) using `/ (root)`! See more in the [hosting](/notes/hosting) guide
### Some of my pages have 'January 1, 0001' as the last modified date
This is a problem caused by `git` treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Quartz by running this command.
@@ -20,29 +34,31 @@ Yes! Quartz makes selective publishing really easy. Heres a guide on [excluding
### Can I host this myself and not on GitHub Pages?
Yes! All built files can be found under `/public` in the `master` branch. More details under [hosting](notes/hosting.md).
### Do I need a website already?
No! Setting up Quartz means you set up a site too :)
### `command not found: hugo-obsidian`
Make sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize `hugo-obsidian` as an executable.
```shell
# Add the following 2 lines to your ~/.bash_profile
# Add the following 2 lines to your ~/.bash_profile (~/.zshrc if you are on Mac)
export GOPATH=/Users/$USER/go
export PATH=$GOPATH/bin:$PATH
# In your current terminal, to reload the session
source ~/.bash_profile
source ~/.bash_profile # again, (~/.zshrc if you are on Mac)
```
### How come my notes aren't being rendered?
You probably forgot to include front matter in your Markdown files. You can either setup [Obsidian](notes/Obsidian.md) to do this for you or you need to manually define it. More details in [the 'how to edit' guide](notes/editing.md).
You probably forgot to include front matter in your Markdown files. You can either setup [Obsidian](notes/obsidian.md) to do this for you or you need to manually define it. More details in [the 'how to edit' guide](notes/editing.md).
### My custom domain isn't working!
Walk through the steps in [the hosting guide](notes/hosting.md) again. Make sure you wait 30 min to 1 hour for changes to take effect.
### How do I setup Google Analytics?
You can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag.
### How do I setup analytics?
Quartz by default uses [Plausible](https://plausible.io/) for analytics.
If you would prefer to use Google Analytics, you can follow this [guide in the Hugo documentation](https://gohugo.io/templates/internal/#google-analytics).
Alternatively, you can also import your Google Analytics data into Plausible by [following this guide](https://plausible.io/docs/google-analytics-import).
### How do I change the content on the home page?
To edit the main home page, open `/content/_index.md`.
@@ -51,7 +67,7 @@ To edit the main home page, open `/content/_index.md`.
You can change the theme by editing `assets/custom.scss`. More details on customization and themeing can be found in the [customization guide](notes/config.md).
### How do I add images?
You can put images anywhere in the `/content` folder. The only caveat is that you should reference them in your Markdown by prefixing it with a `/`.
You can put images anywhere in the `/content` folder.
```markdown
Example image (source is in content/notes/images/example.png)
@@ -59,7 +75,7 @@ Example image (source is in content/notes/images/example.png)
```
### My Interactive Graph and Backlinks aren't up to date
By default, the `linkIndex.yaml` (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](notes/editing.md)
By default, the `linkIndex.json` (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](notes/editing.md)
### Can I use React/Vue/some other framework?
Not out of the box. You could probably make it work by editing `/layouts/_default/single.html` but that's not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.
@@ -67,4 +83,4 @@ Not out of the box. You could probably make it work by editing `/layouts/_defaul
## Still Stuck?
Quartz isn't perfect! If you're still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on [Twitter](https://twitter.com/_jzhao) and I'll try to get back to you as soon as I can.
🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)
🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)

34
content/notes/updating.md Normal file
View File

@@ -0,0 +1,34 @@
---
title: "Updating"
aliases:
- update
---
Haven't updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made!
```shell
make update
```
Or, if you don't want the interactive parts and just want to force update your local garden (this assumed that you are okay with some of your personalizations been overriden!)
```shell
make update-force
```
Or, manually checkout the changes yourself.
> [!warning] Warning!
>
> If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten!
> Make sure you have a copy of these changes if you don't want to lose them.
```shell
# add Quartz as a remote host
git remote add upstream git@github.com:jackyzha0/quartz.git
# index and fetch changes
git fetch upstream
git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data
```

View File

@@ -1,13 +1,29 @@
name: Jacky Zhao
enableToc: true
openToc: false
enableLinkPreview: true
enableLatex: true
enableCodeBlockTitle: true
enableCodeBlockCopy: true
enableCallouts: true
enableSPA: true
enableFooter: true
enableContextualBacklinks: true
enableRecentNotes: false
enableGitHubEdit: true
enableMermaid: true
GitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content
search:
enableSemanticSearch: false
operandApiKey: "REPLACE-WITH-YOUR-OPERAND-API-KEY"
operandIndexId: "REPLACE-WITH-YOUR-OPERAND-INDEX-ID"
description:
Here is the page description. This is an example Quartz site that details installation,
setup, customization, and troubleshooting for Quartz itself.
Host your second brain and digital garden for free. Quartz features extremely fast full-text search,
Wikilink support, backlinks, local graph, tags, and link previews.
page_title:
"🪴 Quartz 3"
"🪴 Quartz 3.3"
links:
- link_name: Twitter
link: https://twitter.com/_jzhao
- link_name: Github
link: https://github.com/jackyzha0
- link_name: GitHub
link: https://github.com/jackyzha0

View File

@@ -1,6 +1,37 @@
enableLegend: false
enableDrag: true
enableZoom: true
depth: -1 # set to -1 to show full graph
# if true, a Global Graph will be shown on home page with full width, no backlink.
# A different set of Local Graphs will be shown on sub pages.
# if false, Local Graph will be default on every page as usual
enableGlobalGraph: false
### Local Graph ###
localGraph:
enableLegend: false
enableDrag: true
enableZoom: true
depth: 1 # set to -1 to show full graph
scale: 1.2
repelForce: 2
centerForce: 1
linkDistance: 1
fontSize: 0.6
opacityScale: 3
### Global Graph ###
globalGraph:
enableLegend: false
enableDrag: true
enableZoom: true
depth: -1 # set to -1 to show full graph
scale: 1.4
repelForce: 1
centerForce: 1
linkDistance: 1
fontSize: 0.5
opacityScale: 3
### For all graphs ###
paths:
- /moc: "#4388cc"
- /moc: "#4388cc"

65
i18n/ar.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "يبدو أنك ضللت الطريق. هذه الصفحة غير موجودة (أو قد تكون خاصة)."
[404_back]
other = "↳ العودة للرئيسية."
[all_posts]
other = "كل منشورات {{.Title}}"
[last_updated]
other = "آخر تعديل"
[notes_count]
other = "ملاحظات بهذه التسمية"
[first_10]
other = "(تعرض أول 10 نتائج فقط)"
[tag]
other = "التسمية"
[backlinks]
other = "الروابط الخلفية"
[no_backlinks]
other = "لا توجد روابط خلفية"
[home]
other = "الرئيسية"
[light_mode]
other = "السمة الفاتحة"
[dark_mode]
other = "السمة الداكنة"
[edit_source]
other = "تعديل المصدر"
[interactive_graph]
other = "المخطط التفاعلي"
[search]
other = "البحث"
[search_icon]
other = "أيقونة البحث"
[icon_search]
other = "أيقونة فتح نافذة البحث"
[recent_notes]
other = "الملاحظات اﻷخيرة"
[first_3_notes]
other = "أول 3 {{ .notes }}"
[search_for_something]
other = "ابحث عن شيء ما..."
[toc]
other = "الفهرس"
[copyright]
other = "صُمم بواسطة {{ .name }} باستخدام <a href='https://github.com/jackyzha0/quartz'>كوارتز</a>، {{ .year }} ©"

65
i18n/bn.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "এই পাতাটি নেই (অথবা ব্যক্তিগত)"
[404_back]
other = "↳ হোম পেজে ফিরে যাই"
[all_posts]
other = "সকল {{.Title}}"
[last_updated]
other = "সর্বশেষ পরিবর্তিত"
[notes_count]
other = "সংখ্যক এই ট্যাগের"
[first_10]
other = "প্রথম ১০ টি ফলাফল"
[tag]
other = "ট্যাগ"
[backlinks]
other = "পিছন পাতা"
[no_backlinks]
other = "পিছনে কোন পাতা নেই"
[home]
other = "হোম"
[light_mode]
other = "আলোকিত"
[dark_mode]
other = "অন্ধকার"
[edit_source]
other = "সম্পাদন করুন"
[interactive_graph]
other = "জ্ঞানকোষের গ্রাফ"
[search]
other = "খুঁজুন"
[search_icon]
other = "খোঁজার আইকন"
[icon_search]
other = "জ্ঞানকোষ"
[recent_notes]
other = "সাম্প্রতিক"
[first_3_notes]
other = "প্রথম ৩ {{ .notes }}"
[search_for_something]
other = "খুঁজুন..."
[toc]
other = "সূচিপত্র"
[copyright]
other = "{{ .name }} কর্তৃক <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a> ব্যবহার করে তৈরিকৃত © {{ .year }}"

65
i18n/de.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "Hey! Hast du dich verirrt? Diese Seite existiert leider nicht (oder ist privat)."
[404_back]
other = "↳ Zurück zur Startseite."
[all_posts]
other = "Alle {{.Title}}"
[last_updated]
other = "Zuletzt aktualisiert"
[notes_count]
other = "Beiträge mit diesem Tag"
[first_10]
other = "Zeige die ersten 10 Ergebnisse"
[tag]
other = "Tag"
[backlinks]
other = "Backlinks"
[no_backlinks]
other = "Keine Backlinks gefunden"
[home]
other = "Home"
[light_mode]
other = "Light Mode"
[dark_mode]
other = "Dark Mode"
[edit_source]
other = "Quelldatei bearbeiten"
[interactive_graph]
other = "Interaktiver Graph"
[search]
other = "Suche"
[search_icon]
other = "Suchsymbol"
[icon_search]
other = "Symbol, um die Suche zu öffnen"
[recent_notes]
other = "Neuste Beiträge"
[first_3_notes]
other = "Die ersten 3 {{ .notes }}"
[search_for_something]
other = "Suche nach etwas ..."
[toc]
other = "Inhaltsverzeichnis"
[copyright]
other = "Made by {{ .name }} using <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a>, © {{ .year }}"

65
i18n/en.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "Hey! You look a little lost. This page doesn't exist (or may be private)."
[404_back]
other = "↳ Let's get you home."
[all_posts]
other = "All {{.Title}}"
[last_updated]
other = "Last updated"
[notes_count]
other = "notes with this tag"
[first_10]
other = "showing first 10 results"
[tag]
other = "Tag"
[backlinks]
other = "Backlinks"
[no_backlinks]
other = "No backlinks found"
[home]
other = "Home"
[light_mode]
other = "Light Mode"
[dark_mode]
other = "Dark Mode"
[edit_source]
other = "Edit Source"
[interactive_graph]
other = "Interactive Graph"
[search]
other = "Search"
[search_icon]
other = "Search Icon"
[icon_search]
other = "Icon to open search"
[recent_notes]
other = "Recent Notes"
[first_3_notes]
other = "first 3 {{ .notes }}"
[search_for_something]
other = "Search for something..."
[toc]
other = "Table of Contents"
[copyright]
other = "Made by {{ .name }} using <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a>, © {{ .year }}"

65
i18n/es.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "Hey! Te ves un poco perdido. Esta página no existe (o puede que sea privada)."
[404_back]
other = "↳ Vamos a llevarte de regreso a casa."
[all_posts]
other = "Todos {{.Title}}"
[last_updated]
other = "Actualizado por última vez"
[notes_count]
other = "notas con esta etiqueta"
[first_10]
other = "mostrando los primeros 10 resultados"
[tag]
other = "Etiqueta"
[backlinks]
other = "Backlinks"
[no_backlinks]
other = "No se encontraron backlinks"
[home]
other = "Casa"
[light_mode]
other = "Modo Claro"
[dark_mode]
other = "Modo Oscuro"
[edit_source]
other = "Editar Fuente"
[interactive_graph]
other = "Gráfico Interactivo"
[search]
other = "Búsqueda"
[search_icon]
other = "Ícono de Búsqueda"
[icon_search]
other = "Ícono para abrir la búsqueda"
[recent_notes]
other = "Notas Recientes"
[first_3_notes]
other = "primeras 3 {{ .notes }}"
[search_for_something]
other = "Buscar algo..."
[toc]
other = "Tabla de Contenido"
[copyright]
other = "Hecho por {{ .name }} usando <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a>, © {{ .year }}"

65
i18n/fr.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "Hey ! Vous semblez perdu‧e. Cette page n'existe pas (ou est privée)."
[404_back]
other = "↳ Clique ici pour retourner sur la page d'accueil"
[all_posts]
other = "Tout {{.Title}}"
[last_updated]
other = "Dernière modification"
[notes_count]
other = "notes avec ce tag"
[first_10]
other = "les 10 premiers résultats"
[tag]
other = "Tag"
[backlinks]
other = "Backlinks"
[no_backlinks]
other = "Pas de backlinks trouvés"
[home]
other = "Accueil"
[light_mode]
other = "Mode Clair"
[dark_mode]
other = "Mode Sombre"
[edit_source]
other = "Modifier la source"
[interactive_graph]
other = "Graphique interactif"
[search]
other = "Rechercher"
[search_icon]
other = "l'icône de recherche"
[icon_search]
other = "L'icône pour ouvrir la recherche"
[recent_notes]
other = "Notes récentes"
[first_3_notes]
other = "les 3 premières {{ .notes }}"
[search_for_something]
other = "Rechercher quelque-chose..."
[toc]
other = "Table des matières"
[copyright]
other = "Fait par {{ .name }} en utilisant <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a>, © {{ .year }}"

65
i18n/it.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "Hey, ti sei perso? Questa pagina non esiste (o è privata)"
[404_back]
other = "↳ Torna alla home."
[all_posts]
other = "Tutti {{.Title}}"
[last_updated]
other = "Ultima modifica"
[notes_count]
other = "note con questo tag"
[first_10]
other = "mostrando i primi 10 risultati"
[tag]
other = "Tag"
[backlinks]
other = "Backlinks"
[no_backlinks]
other = "Nessun Backlink trovato"
[home]
other = "Home"
[light_mode]
other = "Modalità Chiara"
[dark_mode]
other = "Modalità Scura"
[edit_source]
other = "Modifica Sorgente"
[interactive_graph]
other = "Grafico Interattivo"
[search]
other = "Cerca"
[search_icon]
other = "Icona di ricerca"
[icon_search]
other = "Icona per aprire la ricerca"
[recent_notes]
other = "Note Recenti"
[first_3_notes]
other = "prime 3 {{ .notes }}"
[search_for_something]
other = "Cerca qualcosa..."
[toc]
other = "Indice"
[copyright]
other = "Realizzato da {{ .name }} con <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a>, © {{ .year }}"

65
i18n/no.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "Hei! Ser ut til at du har gått deg vill. Denne siden finnes ikke (eller den kan være privat)."
[404_back]
other = "↳ La oss få deg hjem."
[all_posts]
other = "Alle {{.Title}}"
[last_updated]
other = "Sist oppdatert"
[notes_count]
other = "notater med denne taggen"
[first_10]
other = "viser første 10 resultatene"
[tag]
other = "Tag"
[backlinks]
other = "Tilbakekoblinger"
[no_backlinks]
other = "Ingen tilbakekoblinger funnet"
[home]
other = "Hjem"
[light_mode]
other = "Lys Modus"
[dark_mode]
other = "Mørk Modus"
[edit_source]
other = "Rediger Kilde"
[interactive_graph]
other = "Interaktiv Graf"
[search]
other = "Søk"
[search_icon]
other = "Søkeikon"
[icon_search]
other = "Ikon for å åpne søk"
[recent_notes]
other = "Nylige notater"
[first_3_notes]
other = "første 3 {{ .notes }}"
[search_for_something]
other = "Søk etter noe..."
[toc]
other = "Innholdsfortegnelse"
[copyright]
other = "Opprettet av {{ .name }} ved hjelp av <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a>, © {{ .year }}"

65
i18n/tr.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "Hey! Biraz kaybolmuş görünüyorsun. Bu sayfa mevcut değil (veya özel olabilir)."
[404_back]
other = "↳ Seni eve götürelim."
[all_posts]
other = "Hepsi {{.Title}}"
[last_updated]
other = "Son güncelleme"
[notes_count]
other = "Bu etikete sahip notlar"
[first_10]
other = "İlk 10 sonuç gösteriliyor"
[tag]
other = "Etiket"
[backlinks]
other = "Geri bağlantılar"
[no_backlinks]
other = "Geri bağlantı bulunamadı"
[home]
other = "Ev"
[light_mode]
other = "Aydınlık Modu"
[dark_mode]
other = "Karanlık Modu"
[edit_source]
other = "Kaynağı Düzenle"
[interactive_graph]
other = "Etkileşimli Grafik"
[search]
other = "Ara"
[search_icon]
other = "Arama Simgesi"
[icon_search]
other = "Aramayı açmak için simge tıklayın"
[recent_notes]
other = "Son Notlar"
[first_3_notes]
other = "İlk Üç {{ .notes }}"
[search_for_something]
other = "Bir şey ara..."
[toc]
other = "İçindekiler"
[copyright]
other = "{{ .name }} tarafından <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a> kullanılarak yapılmıştır, © {{ .year }}"

65
i18n/uk.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "Хей! Виглядаєте здивовано. Цієї сторінки не існує (або вона приватна)."
[404_back]
other = "↳ Повернемося додому."
[all_posts]
other = "Всі {{.Title}}"
[last_updated]
other = "Оновлено"
[notes_count]
other = "нонаток з цим тегом"
[first_10]
other = "показано 10 перших результатів"
[tag]
other = "Тег"
[backlinks]
other = "Зворотнє посилання"
[no_backlinks]
other = "Зворотних посилань не знайдено"
[home]
other = "Дім"
[light_mode]
other = "Світлий Режим"
[dark_mode]
other = "Темний Режим"
[edit_source]
other = "Редагувати Джерело"
[interactive_graph]
other = "Інтерактивний граф"
[search]
other = "Пошук"
[search_icon]
other = "Іконка Пошуку"
[icon_search]
other = "Іконка для відкриття пошуку"
[recent_notes]
other = "Нещодавні Нотатки"
[first_3_notes]
other = "перші 3 {{ .notes }}"
[search_for_something]
other = "Знайти щось..."
[toc]
other = "Зміст"
[copyright]
other = "Створено {{ .name }} з використанням <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a>, © {{ .year }}"

65
i18n/zh-cn.toml Normal file
View File

@@ -0,0 +1,65 @@
[404_message]
other = "喔哦...... 你是不是迷路了呀..... (⌯' '⌯ ) 这个页面并不存在(也许它还未被发布)。"
[404_back]
other = "↳ 回到主页"
[all_posts]
other = "所有 {{.Title}}"
[last_updated]
other = "最后更新于"
[notes_count]
other = "带有此标签的笔记"
[first_10]
other = "正在展示前10个结果"
[tag]
other = "标签"
[backlinks]
other = "反向链接"
[no_backlinks]
other = "没有找到反向链接"
[home]
other = "主页"
[light_mode]
other = "明亮模式"
[dark_mode]
other = "黑暗模式"
[edit_source]
other = "编辑源码"
[interactive_graph]
other = "互动图"
[search]
other = "搜索"
[search_icon]
other = "搜索图标"
[icon_search]
other = "打开搜索图标"
[recent_notes]
other = "近期笔记"
[first_3_notes]
other = "前3个 {{ .notes }}"
[search_for_something]
other = "进行搜索......"
[toc]
other = "目录"
[copyright]
other = "由 {{ .name }} 用 <a href=\"https://github.com/jackyzha0/quartz\">Quartz</a> 创造, © {{ .year }}"

View File

@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html lang="en">
<html lang="{{ .Lang }}">
{{ partial "head.html" . }}
<body>
@@ -7,10 +7,9 @@
{{partial "darkmode.html" .}}
<div class="centered">
<h1>404.</h1>
<h3>Hey! You look a little lost. This page doesn't exist (or may be private).</h3>
<a href="/">↳ Let's get you home.</a>
<h3>{{ i18n "404_message" }}</h3>
<a href="{{ .Site.BaseURL }}">{{ i18n "404_back" }}</a>
</div>
</div>
</body>
</html>

View File

@@ -0,0 +1,4 @@
<div class="mermaid">
{{- .Inner | safeHTML }}
</div>
{{ .Page.Store.Set "hasMermaid" true }}

View File

@@ -0,0 +1,9 @@
{{$src := .Destination | safeURL }}
{{$width := index (split .Text "|") 1 | default "auto" }}
{{$external := strings.HasPrefix $src "http" }}
{{- if $external -}}
<img src="{{ $src }}" width="{{ $width }}" alt="{{ .Text }}" {{ with .Title }} title="{{ . }}" {{ end }} />
{{- else -}}
{{$fixedUrl := (cond (hasPrefix $src "/") $src (print "/" $src)) | urlize}}
<img src="{{.Page.Site.BaseURL}}{{ $fixedUrl }}" width="{{ $width }}" alt="{{ .Text }}" {{ with .Title }} title="{{ . }}" {{ end }} />
{{- end -}}

View File

@@ -1,9 +1,16 @@
{{$trimmed := strings.TrimSuffix ".md" (.Destination | safeURL)}}
{{$trimmed = replace $trimmed "%20" "-" }}
{{$external := strings.HasPrefix $trimmed "http" }}
{{$dashedurl := replace .Destination "%20" "-" }}
{{$external := strings.HasPrefix $dashedurl "http" }}
{{- if $external -}}
<a href="{{ $trimmed }}" rel="noopener">{{ .Text | safeHTML }}</a>
<a href="{{ $dashedurl }}" rel="noopener">{{ .Text | safeHTML }}</a>
{{- else -}}
{{$fixedUrl := (cond (hasPrefix $trimmed "/") $trimmed (print "/" $trimmed)) | urlize}}
<a href="{{$fixedUrl}}" rel="noopener" class="internal-link" data-src="{{$fixedUrl}}">{{ .Text | safeHTML }}</a>
{{- end -}}
{{$trimmed := strings.TrimSuffix ".md" (.Destination | safeURL)}}
{{$spacedurl := replace $trimmed "%20" " " }}
{{$fixedUrl := (cond (hasPrefix $spacedurl "/") $spacedurl (print "/" $spacedurl)) | urlize}}
{{$nonexistent := eq (.Page.GetPage $spacedurl).RelPermalink ""}}
{{$rooted := default $spacedurl ((.Page.GetPage $spacedurl).RelPermalink) }}
<a
{{if not $nonexistent}}href="{{$rooted}}"{{end}}
rel="noopener" class="internal-link{{if $nonexistent}} broken{{end}}"
data-src="{{$rooted}}">{{- .Text | safeHTML -}}
</a>
{{- end -}}

View File

@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html lang="en">
<html lang="{{ .Lang }}">
{{ block "head" . }}
{{ end }}

View File

@@ -1,24 +1,21 @@
<!DOCTYPE html>
<html lang="en">
<html lang="{{ .Lang }}">
{{ partial "head.html" . }}
<body>
{{partial "search.html" .}}
<div class="singlePage">
<!-- Begin actual content -->
<header>
<h1 id="page-title"><a href="{{ .Site.BaseURL }}">{{ .Site.Data.config.page_title }}</a></h1>
<svg tabindex="0" id="search-icon" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">Search Icon</title><desc id="desc">Icon to open search</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"/><circle cx="8" cy="8" r="7"/></g></svg>
<div class="spacer"></div>
{{partial "darkmode.html" .}}
</header>
{{partial "header.html" .}}
<article>
<h1>All {{.Title}}</h1>
<h1>{{ i18n "all_posts" . }}</h1>
{{with .Params.description}}
<p>{{.}}</p>
{{end}}
{{partial "page-list.html" .Paginator.Pages.ByLastmod.Reverse }}
{{ template "_internal/pagination.html" .}}
</article>
{{partial "contact.html" .}}
</div>
</body>
</html>

View File

@@ -1,38 +1,34 @@
<!DOCTYPE html>
<html lang="en">
<html lang="{{ .Lang }}">
{{ partial "head.html" . }}
<body>
{{partial "search.html" .}}
<div class="singlePage">
<!-- Begin actual content -->
<header>
<h1 id="page-title"><a href="{{ .Site.BaseURL }}">{{ .Site.Data.config.page_title }}</a></h1>
<svg tabindex="0" id="search-icon" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">Search Icon</title><desc id="desc">Icon to open search</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"/><circle cx="8" cy="8" r="7"/></g></svg>
<div class="spacer"></div>
{{partial "darkmode.html" .}}
</header>
<article>
{{partial "header.html" .}}
<article>
{{if .Title}}<h1>{{ .Title }}</h1>{{end}}
<p class="meta">
Last updated {{if ne .Date .Lastmod}}{{ .Lastmod.Format "January 2, 2006" }}{{else}}Unknown{{end}}
{{ i18n "last_updated" }} {{ partial "date-fmt.html" .}}
{{ partial "github.html" . }}
</p>
<ul class="tags">
{{ range (.GetTerms "tags") }}
<li><a href="{{ .Permalink }}">{{ .LinkTitle | humanize }}</a></li>
<li><a href="{{ .Permalink }}">
{{if (eq $.Site.Language.Lang "en")}}
{{ .LinkTitle | humanize }}
{{else}}
{{ .LinkTitle }}
{{end}}
</a>
</li>
{{ end }}
</ul>
{{if $.Site.Data.config.enableToc}}
<aside class="mainTOC">
<h3>Table of Contents</h3>
{{ .TableOfContents }}
</aside>
{{end}}
{{.Content}}
{{partial "toc.html" .}}
{{partial "textprocessing.html" . }}
</article>
{{partial "footer.html" .}}
</div>
</body>
</html>

View File

@@ -1,27 +1,25 @@
<!DOCTYPE html>
<html lang="en">
<html lang="{{ .Lang }}">
{{ partial "head.html" . }}
<body>
{{partial "search.html" .}}
<div class="singlePage">
<!-- Begin actual content -->
<header>
<h1 id="page-title"><a href="{{ .Site.BaseURL }}">{{ .Site.Data.config.page_title }}</a></h1>
<svg tabindex="0" id="search-icon" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">Search Icon</title><desc id="desc">Icon to open search</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"/><circle cx="8" cy="8" r="7"/></g></svg>
<div class="spacer"></div>
{{partial "darkmode.html" .}}
</header>
{{partial "header.html" .}}
<article>
<h1>All {{.Title}}</h1>
<h1>{{ i18n "all_posts" . }}</h1>
{{with .Params.description}}
<p>{{.}}</p>
{{end}}
<div class="tags">
{{ range .Site.Taxonomies.tags.ByCount }}
<div class="meta">
<h1><a href="{{ .Page.Permalink }}">{{ .Page.Title }}</a></h1>
<p><b>{{ .Count }}</b> notes with this tag {{if gt .Count 2}}(showing first 2 results){{end}}</p>
<h1><a href="{{ .Page.Permalink }}">{{ .Page.Title | humanize }}</a></h1>
<p><b>{{ .Count }}</b> {{ i18n "notes_count" }} {{if gt .Count 10}}({{ i18n "first_10"}}){{end}}</p>
</div>
{{ with ($.Site.GetPage (printf "/tags/%s" .Page.Title)) }}
{{partial "page-list.html" (first 2 .Pages.ByLastmod.Reverse)}}
{{partial "page-list.html" (first 10 .Pages.ByLastmod.Reverse)}}
{{ end }}
{{ end }}
</div>
@@ -29,5 +27,4 @@
{{partial "contact.html" .}}
</div>
</body>
</html>

View File

@@ -1,24 +1,21 @@
<!DOCTYPE html>
<html lang="en">
<html lang="{{ .Lang }}">
{{ partial "head.html" . }}
<body>
{{partial "search.html" .}}
<div class="singlePage">
<!-- Begin actual content -->
<header>
<h1 id="page-title"><a href="{{ .Site.BaseURL }}">{{ .Site.Data.config.page_title }}</a></h1>
<svg tabindex="0" id="search-icon" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">Search Icon</title><desc id="desc">Icon to open search</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"/><circle cx="8" cy="8" r="7"/></g></svg>
<div class="spacer"></div>
{{partial "darkmode.html" .}}
</header>
{{partial "header.html" .}}
<article>
<h1>Tag: {{.Title | humanize}}</h1>
<h1>{{ i18n "tag" }}: {{ .Title }}</h1>
{{with .Params.description}}
<p>{{.}}</p>
{{end}}
{{partial "page-list.html" .Paginator.Pages}}
{{ template "_internal/pagination.html" . }}
</article>
{{partial "contact.html" .}}
</div>
</body>
</html>

View File

@@ -1,28 +1,20 @@
<!DOCTYPE html>
<html lang="en">
<html lang="{{ .Lang }}">
{{ partial "head.html" . }}
<body>
{{partial "search.html" .}}
<div class="singlePage">
<!-- Begin actual content -->
<header>
<h1>{{if .Title}}{{ .Title }}{{else}}Untitled{{end}}</h1>
<svg tabindex="0" id="search-icon" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">Search Icon</title><desc id="desc">Icon to open search</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"/><circle cx="8" cy="8" r="7"/></g></svg>
<div class="spacer"></div>
{{partial "darkmode.html" .}}
</header>
{{partial "header.html" .}}
<article>
{{if $.Site.Data.config.enableToc}}
<aside class="mainTOC">
<h3>Table of Contents</h3>
{{ .TableOfContents }}
</aside>
{{partial "toc.html" .}}
{{partial "textprocessing.html" . }}
{{if $.Site.Data.config.enableRecentNotes}}
{{partial "recent.html" . }}
{{end}}
{{- .Content -}}
</article>
{{partial "footer.html" .}}
{{partial "footerIndex.html" .}}
</div>
</body>
</html>

View File

@@ -1,20 +1,30 @@
<h3>Backlinks</h3>
<h3>{{ i18n "backlinks" }}</h3>
<ul class="backlinks">
{{$url := urls.Parse .Site.BaseURL }}
{{$host := strings.TrimRight "/" $url.Path }}
{{$curPage := strings.TrimPrefix $host (strings.TrimRight "/" .Page.RelPermalink) }}
{{$inbound := index $.Site.Data.linkIndex.index.backlinks $curPage}}
{{$contentTable := $.Site.Data.contentIndex}}
{{$curPage := strings.TrimPrefix $host (strings.TrimRight "/" .Page.RelPermalink)}}
{{$linkIndex := getJSON "/assets/indices/linkIndex.json"}}
{{$inbound := index $linkIndex.index.backlinks $curPage}}
{{$contentTable := getJSON "/assets/indices/contentIndex.json"}}
{{if $inbound}}
{{$cleanedInbound := apply (apply $inbound "index" "." "source") "replace" "." " " "-"}}
{{- range $cleanedInbound | uniq -}}
<li>
<a href="{{.}}">{{index (index $contentTable .) "title"}}</a>
</li>
{{$backlinks := dict "SENTINEL" "SENTINEL"}}
{{range $k, $v := $inbound}}
{{$cleanedInbound := replace $v.source " " "-"}}
{{$ctx := $v.text}}
{{$backlinks = merge $backlinks (dict $cleanedInbound $ctx)}}
{{end}}
{{- range $lnk, $ctx := $backlinks -}}
{{$l := printf "%s%s/" $host $lnk}}
{{$l = cond (eq $l "//") "/" $l}}
{{with (index $contentTable $lnk)}}
<li>
<a href="{{$l}}" data-ctx="{{$ctx}}" data-src="{{$lnk}}" class="internal-link">{{index (index . "title")}}</a>
</li>
{{end}}
{{- end -}}
{{else}}
<li>
No backlinks found
{{ i18n "no_backlinks" }}
</li>
{{end}}
</ul>

View File

@@ -1,12 +1,19 @@
<!-- set data/config yaml file based on website language -->
{{ $config := cond (eq $.Site.Language.Lang "en") "config" (printf "config.%s" $.Site.Language.Lang) }}
{{ $data := index $.Site.Data $config }}
<!-- Contact Info -->
<div id="contact_buttons">
<footer>
<p>Made by {{ $.Site.Data.config.name }} using <a href="https://github.com/jackyzha0/quartz">Quartz</a>, © {{ dateFormat "2006" now }}</p>
{{ if not .IsHome }}
<a href="/">Home</a>
{{end}}
{{- range $.Site.Data.config.links -}}
<a href="{{.link}}">{{.link_name}}</a>
{{- end -}}
{{ $name := $data.name | default $.Site.Data.config.name }}
{{ $year := dateFormat "2006" now }}
<p>{{ i18n "copyright" (dict "name" $name "year" $year) | safeHTML}}</p>
<ul>
{{ if not .IsHome }}
<li><a href="{{ $.Site.BaseURL}}">{{ i18n "home" }}</a></li>
{{end}}
{{- range $data.links | default $.Site.Data.config.links -}}
<li><a href="{{.link}}">{{.link_name}}</a></li>
{{- end -}}
</ul>
</footer>
</div>
</div>

View File

@@ -2,13 +2,13 @@
<input class='toggle' id='darkmode-toggle' type='checkbox' tabindex="-1">
<label id="toggle-label-light" for='darkmode-toggle' tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="dayIcon" x="0px" y="0px" viewBox="0 0 35 35" style="enable-background:new 0 0 35 35;" xml:space="preserve">
<title>Light Mode</title>
<title>{{ i18n "light_mode" }}</title>
<path d="M6,17.5C6,16.672,5.328,16,4.5,16h-3C0.672,16,0,16.672,0,17.5 S0.672,19,1.5,19h3C5.328,19,6,18.328,6,17.5z M7.5,26c-0.414,0-0.789,0.168-1.061,0.439l-2,2C4.168,28.711,4,29.086,4,29.5 C4,30.328,4.671,31,5.5,31c0.414,0,0.789-0.168,1.06-0.44l2-2C8.832,28.289,9,27.914,9,27.5C9,26.672,8.329,26,7.5,26z M17.5,6 C18.329,6,19,5.328,19,4.5v-3C19,0.672,18.329,0,17.5,0S16,0.672,16,1.5v3C16,5.328,16.671,6,17.5,6z M27.5,9 c0.414,0,0.789-0.168,1.06-0.439l2-2C30.832,6.289,31,5.914,31,5.5C31,4.672,30.329,4,29.5,4c-0.414,0-0.789,0.168-1.061,0.44 l-2,2C26.168,6.711,26,7.086,26,7.5C26,8.328,26.671,9,27.5,9z M6.439,8.561C6.711,8.832,7.086,9,7.5,9C8.328,9,9,8.328,9,7.5 c0-0.414-0.168-0.789-0.439-1.061l-2-2C6.289,4.168,5.914,4,5.5,4C4.672,4,4,4.672,4,5.5c0,0.414,0.168,0.789,0.439,1.06 L6.439,8.561z M33.5,16h-3c-0.828,0-1.5,0.672-1.5,1.5s0.672,1.5,1.5,1.5h3c0.828,0,1.5-0.672,1.5-1.5S34.328,16,33.5,16z M28.561,26.439C28.289,26.168,27.914,26,27.5,26c-0.828,0-1.5,0.672-1.5,1.5c0,0.414,0.168,0.789,0.439,1.06l2,2 C28.711,30.832,29.086,31,29.5,31c0.828,0,1.5-0.672,1.5-1.5c0-0.414-0.168-0.789-0.439-1.061L28.561,26.439z M17.5,29 c-0.829,0-1.5,0.672-1.5,1.5v3c0,0.828,0.671,1.5,1.5,1.5s1.5-0.672,1.5-1.5v-3C19,29.672,18.329,29,17.5,29z M17.5,7 C11.71,7,7,11.71,7,17.5S11.71,28,17.5,28S28,23.29,28,17.5S23.29,7,17.5,7z M17.5,25c-4.136,0-7.5-3.364-7.5-7.5 c0-4.136,3.364-7.5,7.5-7.5c4.136,0,7.5,3.364,7.5,7.5C25,21.636,21.636,25,17.5,25z" />
</svg>
</label>
<label id="toggle-label-dark" for='darkmode-toggle' tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="nightIcon" x="0px" y="0px" viewBox="0 0 100 100" style="enable-background='new 0 0 100 100'" xml:space="preserve">
<title>Dark Mode</title>
<title>{{ i18n "dark_mode" }}</title>
<path d="M96.76,66.458c-0.853-0.852-2.15-1.064-3.23-0.534c-6.063,2.991-12.858,4.571-19.655,4.571 C62.022,70.495,50.88,65.88,42.5,57.5C29.043,44.043,25.658,23.536,34.076,6.47c0.532-1.08,0.318-2.379-0.534-3.23 c-0.851-0.852-2.15-1.064-3.23-0.534c-4.918,2.427-9.375,5.619-13.246,9.491c-9.447,9.447-14.65,22.008-14.65,35.369 c0,13.36,5.203,25.921,14.65,35.368s22.008,14.65,35.368,14.65c13.361,0,25.921-5.203,35.369-14.65 c3.872-3.871,7.064-8.328,9.491-13.246C97.826,68.608,97.611,67.309,96.76,66.458z" />
</svg>
</label>

View File

@@ -0,0 +1,7 @@
{{if .Date}}
{{.Date.Format "Jan 2, 2006"}}
{{else if .Lastmod}}
{{.Lastmod.Format "Jan 2, 2006"}}
{{else}}
Unknown
{{end}}

View File

@@ -1,5 +1,9 @@
<hr/>
<div class="page-end">
{{if $.Site.Data.config.enableFooter}}
<div class="page-end" id="footer">
<div class="backlinks-container">
{{partial "backlinks.html" .}}
</div>
@@ -7,5 +11,6 @@
{{partial "graph.html" .}}
</div>
</div>
{{end}}
{{partial "contact.html" .}}
{{partial "contact.html" .}}

View File

@@ -0,0 +1,24 @@
{{if $.Site.Data.config.enableFooter}}
{{if $.Site.Data.graphConfig.enableGlobalGraph}}
<div class="page-end" id="footer">
<div>
{{partial "graph.html" .}}
</div>
</div>
{{else}}
<hr/>
<div class="page-end" id="footer">
<div class="backlinks-container">
{{partial "backlinks.html" .}}
</div>
<div>
{{partial "graph.html" .}}
</div>
</div>
{{end}}
{{end}}
{{partial "contact.html" .}}

View File

@@ -0,0 +1,3 @@
{{if $.Site.Data.config.enableGitHubEdit}}
<a href="{{$.Site.Data.config.GitHubLink}}/{{.File.Path}}" rel="noopener">{{ i18n "edit_source" }}</a>
{{end}}

View File

@@ -1,236 +1,18 @@
<script src="https://cdn.jsdelivr.net/npm/d3@6"></script>
<h3>Interactive Graph</h3>
<script
src="https://cdn.jsdelivr.net/npm/d3@6.7.0/dist/d3.min.js"
integrity="sha256-+7jaYCp29O1JusNWHaYtgUn6EhuP0VaFuswhNV06MyI="
crossorigin="anonymous"
></script>
<h3>{{ i18n "interactive_graph" }}</h3>
<div id="graph-container"></div>
<style>
:root {
--g-node: var(--secondary);
--g-node-active: var(--primary);
--g-node-inactive: var(--visited);
--g-link: var(--outlinegray);
--g-link-active: #5a7282;
}
:root {
--g-node: var(--secondary);
--g-node-active: var(--primary);
--g-node-inactive: var(--visited);
--g-link: var(--outlinegray);
--g-link-active: #5a7282;
}
</style>
<script>
const curPage = {{ strings.TrimRight "/" .Page.RelPermalink }}
const pathColors = {{$.Site.Data.graphConfig.paths}}
let depth = {{$.Site.Data.graphConfig.depth}}
const parseIdsFromLinks = (links) => [...(new Set(links.flatMap(link => ([link.source, link.target]))))]
const neighbours = new Set()
const wl = [curPage || "/", "__SENTINEL"]
if (depth >= 0) {
while (depth >= 0 && wl.length > 0) {
// compute neighbours
const cur = wl.shift()
if (cur === "__SENTINEL") {
depth--
wl.push("__SENTINEL")
} else {
neighbours.add(cur)
const outgoing = index.links[cur] || []
const incoming = index.backlinks[cur] || []
wl.push(...outgoing.map(l => l.target), ...incoming.map(l => l.source))
}
}
} else {
parseIdsFromLinks(links).forEach(id => neighbours.add(id))
}
const data = {
nodes: [...neighbours].map(id => ({id})),
links: links.filter(l => neighbours.has(l.source) && neighbours.has(l.target)),
}
const color = (d) => {
if (d.id === curPage || (d.id === "/" && curPage === "")) {
return "var(--g-node-active)"
}
for (const pathColor of pathColors) {
const path = Object.keys(pathColor)[0]
const colour = pathColor[path]
if (d.id.startsWith(path)) {
return colour
}
}
return "var(--g-node)"
}
const drag = simulation => {
function dragstarted(event, d) {
if (!event.active) simulation.alphaTarget(1).restart();
d.fx = d.x;
d.fy = d.y;
}
function dragged(event,d) {
d.fx = event.x;
d.fy = event.y;
}
function dragended(event,d) {
if (!event.active) simulation.alphaTarget(0);
d.fx = null;
d.fy = null;
}
const enableDrag = {{$.Site.Data.graphConfig.enableDrag}}
const noop = () => {}
return d3.drag()
.on("start", enableDrag ? dragstarted : noop)
.on("drag", enableDrag ? dragged : noop)
.on("end", enableDrag ? dragended : noop);
}
const height = 250
const width = document.getElementById("graph-container").offsetWidth
const simulation = d3.forceSimulation(data.nodes)
.force("charge", d3.forceManyBody().strength(-30))
.force("link", d3.forceLink(data.links).id(d => d.id))
.force("center", d3.forceCenter());
const svg = d3.select('#graph-container')
.append('svg')
.attr('width', width)
.attr('height', height)
.attr("viewBox", [-width / 2, -height / 2, width, height]);
// legend
const enableLegend = {{$.Site.Data.graphConfig.enableLegend}}
if (enableLegend) {
const legend = [
{"Current": "var(--g-node-active)"},
{"Note": "var(--g-node)"},
...pathColors
]
legend.forEach((legendEntry, i) => {
const key = Object.keys(legendEntry)[0]
const colour = legendEntry[key]
svg.append("circle").attr("cx", -width/2 + 20).attr("cy", height/2 - 30 * (i+1)).attr("r", 6).style("fill", colour)
svg.append("text").attr("x", -width/2 + 40).attr("y", height/2 - 30 * (i+1)).text(key).style("font-size", "15px").attr("alignment-baseline","middle")
})
}
// draw links between nodes
const link = svg.append("g")
.selectAll("line")
.data(data.links)
.join("line")
.attr("class", "link")
.attr("stroke", "var(--g-link)")
.attr("stroke-width", 2)
.attr("data-source", d => d.source.id)
.attr("data-target", d => d.target.id)
// svg groups
const graphNode = svg.append("g")
.selectAll("g")
.data(data.nodes)
.enter().append("g")
// draw individual nodes
const node = graphNode.append("circle")
.attr("class", "node")
.attr("id", (d) => d.id)
.attr("r", (d) => {
const numOut = index.links[d.id]?.length || 0
const numIn = index.backlinks[d.id]?.length || 0
return 3 + (numOut + numIn) / 4
})
.attr("fill", color)
.style("cursor", "pointer")
.on("click", (_, d) => {
window.location.href = {{.Site.BaseURL}} + decodeURI(d.id).replace(/[\s_]+/g, '-')
})
.on("mouseover", function (_, d) {
d3.selectAll(".node")
.transition()
.duration(100)
.attr("fill", "var(--g-node-inactive)")
const neighbours = parseIdsFromLinks([...(index.links[d.id] || []), ...(index.backlinks[d.id] || [])])
const neighbourNodes = d3.selectAll(".node").filter(d => neighbours.includes(d.id))
const currentId = d.id
const linkNodes = d3.selectAll(".link").filter(d => d.source.id === currentId || d.target.id === currentId)
// highlight neighbour nodes
neighbourNodes
.transition()
.duration(200)
.attr("fill", color)
// highlight links
linkNodes
.transition()
.duration(200)
.attr("stroke", "var(--g-link-active)")
// show text for self
d3.select(this.parentNode)
.select("text")
.raise()
.transition()
.duration(200)
.style("opacity", 1)
}).on("mouseleave", function (_,d) {
d3.selectAll(".node")
.transition()
.duration(200)
.attr("fill", color)
const currentId = d.id
const linkNodes = d3.selectAll(".link").filter(d => d.source.id === currentId || d.target.id === currentId)
linkNodes
.transition()
.duration(200)
.attr("stroke", "var(--g-link)")
d3.select(this.parentNode)
.select("text")
.transition()
.duration(200)
.style("opacity", 0)
})
.call(drag(simulation));
// draw labels
const labels = graphNode.append("text")
.attr("dx", 12)
.attr("dy", ".35em")
.text((d) => content[decodeURI(d.id).replace(/[\s_]+/g, '-')]?.title || "Untitled")
.style("opacity", 0)
.style("pointer-events", "none")
.call(drag(simulation));
// set panning
const enableZoom = {{$.Site.Data.graphConfig.enableZoom}}
if (enableZoom) {
svg.call(d3.zoom()
.extent([[0, 0], [width, height]])
.scaleExtent([0.25, 4])
.on("zoom", ({transform}) => {
link.attr("transform", transform);
node.attr("transform", transform);
labels.attr("transform", transform);
}));
}
// progress the simulation
simulation.on("tick", () => {
link
.attr("x1", d => d.source.x)
.attr("y1", d => d.source.y)
.attr("x2", d => d.target.x)
.attr("y2", d => d.target.y);
node
.attr("cx", d => d.x)
.attr("cy", d => d.y);
labels
.attr("x", d => d.x)
.attr("y", d => d.y);
});
</script>
{{ $js := resources.Get "js/graph.js" | resources.Fingerprint "md5" }}
<script src="{{ $js.Permalink }}"></script>

View File

@@ -1,35 +1,252 @@
<!-- set data/config yaml file based on website language -->
{{ $config := cond (eq $.Site.Language.Lang "en") "config" (printf "config.%s" $.Site.Language.Lang) }}
{{ $data := index $.Site.Data $config }}
<head>
<!-- Meta tags -->
<meta charset="UTF-8">
<meta name="description" content="{{if .IsHome}}{{$.Site.Data.config.description}}{{else}}{{.Summary}}{{end}}">
<title>{{ if .Title }}{{ .Title }}{{ else }}{{ $.Site.Data.config.page_title }}{{ end }}</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" type="image/png" href="/icon.png" />
<!-- Meta tags -->
<meta charset="UTF-8" />
<meta
name="description"
content="{{if .IsHome}}{{$data.description | default $.Site.Data.config.description}}{{else}}{{.Summary}}{{end}}"
/>
<meta property="og:title" content="{{ .Title }}">
<meta property="og:description" content="{{if .IsHome}}{{$data.description | default $.Site.Data.config.description}}{{else}}{{.Summary}}{{end}}">
<meta property="og:type" content="website">
<meta property="og:image" content="{{.Site.BaseURL}}icon.png">
<meta property="og:url" content="{{ .Permalink }}">
<meta property="og:width" content="200">
<meta property="og:height" content="200">
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content="{{ .Title }}" />
<meta name="twitter:description" content="{{if .IsHome}}{{$data.description | default $.Site.Data.config.description}}{{else}}{{.Summary}}{{end}}" />
<meta name="twitter:image" content="{{.Site.BaseURL}}icon.png">
{{ range $data.links }}
{{ if strings.Contains .link "twitter.com" }}
{{ $twitter_handle := index (split .link "/") (sub (len (split .link "/")) 1) }}
<meta name="twitter:site" content="{{ $twitter_handle }}" />
{{ end }}
{{ end }}
<!-- CSS Stylesheets and Fonts -->
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700&family=Source+Sans+Pro:wght@400;600;700&family=Fira+Code:wght@400;700&display=swap" rel="stylesheet">
{{ $css := slice "custom.scss" "base.scss" "darkmode.scss" "syntax.scss"}}
{{range $css}}
{{$sass := resources.Get . | resources.ToCSS }}
{{with $sass | minify}}
<style>
{{.Content | safeCSS}}
</style>
{{end}}
{{end}}
<title>
{{ if .Title }}{{ .Title }}{{ else }}{{ $data.page_title | default $.Site.Data.config.page_title }}{{
end }}
</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
{{- with resources.Get "darkmode.js" | minify -}}
<script>
{{.Content | safeJS }}
</script>
{{- end -}}
<!-- HTML Favicon -->
{{ $favicon := $data.favicon | default $.Site.Data.config.favicon | default (slice (dict "rel" "shortcut icon" "type" "image/png" "href" "icon.png")) }}
{{ $type := (printf "%T" $favicon) }}
{{ if eq $type "string" }}
{{ $favicon | safeHTML }}
{{ else }}
{{ range $favicon }}
<link rel="{{.rel}}" {{if .type}}type="{{.type}}"{{end}} {{if .sizes}}sizes="{{.sizes}}"{{end}} href="{{$.Site.BaseURL}}/{{.href}}" />
{{- end }}
{{ end }}
<!-- Preload page vars -->
<script>
const content = {{$.Site.Data.contentIndex}}
const index = {{$.Site.Data.linkIndex.index}}
const links = {{$.Site.Data.linkIndex.links}}
</script>
<!-- CSS Stylesheets and Fonts -->
{{$sass := resources.Match "styles/[!_]*.scss" }}
{{$css := slice }}
{{range $sass}}
{{$scss := . | resources.ToCSS (dict "outputStyle" "compressed") }}
{{$css = $css | append $scss}}
{{end}}
{{if $data.enableCallouts | default $.Site.Data.config.enableCallouts}}
{{$scss := resources.Get "styles/_callouts.scss" | resources.ToCSS (dict "outputStyle" "compressed") }}
{{$css = $css | append $scss}}
{{end}}
{{$finalCss := $css | resources.Concat "styles.css" | resources.Fingerprint "md5" | resources.Minify }}
<link href="{{$finalCss.Permalink}}" rel="stylesheet" />
{{$lightSyntax := resources.Get "styles/_light_syntax.scss" | resources.ToCSS (dict "outputStyle" "compressed") | resources.Fingerprint "md5" | resources.Minify }}
<link href="{{$lightSyntax.Permalink}}" rel="stylesheet" id="theme-link">
<!-- Base scripts -->
{{$scripts := (slice "js/darkmode.js" "js/util.js")}}
{{range $scripts}}
{{$scriptname := .}}
{{ $s := resources.Get $scriptname | resources.ExecuteAsTemplate $scriptname . | resources.Fingerprint "md5" | resources.Minify }}
<script src="{{$s.Permalink}}"></script>
{{end}}
{{partial "katex.html" .}}
{{partial "mermaid.html" .}}
<script src="https://cdn.jsdelivr.net/npm/@floating-ui/core@1.2.1"></script>
<script src="https://cdn.jsdelivr.net/npm/@floating-ui/dom@1.2.1"></script>
{{ $popover := resources.Get "js/popover.js" | resources.Fingerprint "md5" |
resources.Minify }}
<script defer src="{{$popover.Permalink}}"></script>
<!-- Optional scripts -->
{{ if $data.enableCodeBlockTitle | default $.Site.Data.config.enableCallouts }}
{{ $codeTitle := resources.Get "js/code-title.js" | resources.Fingerprint "md5" | resources.Minify }}
<script defer src="{{$codeTitle.Permalink}}"></script>
{{end}}
{{ if $data.enableCodeBlockCopy | default $.Site.Data.config.enableCodeBlockCopy }}
{{ $clipboard := resources.Get "js/clipboard.js" | resources.Fingerprint "md5" | resources.Minify }}
<script defer src="{{$clipboard.Permalink}}"></script>
{{ end }}
{{ if $data.enableCallouts | default $.Site.Data.config.enableCallouts }}
{{ $callouts := resources.Get "js/callouts.js" | resources.Fingerprint "md5" | resources.Minify }}
<script defer src="{{$callouts.Permalink}}"></script>
{{ end }}
<!-- Preload page vars -->
{{$linkIndex := resources.Get "indices/linkIndex.json" | resources.Fingerprint
"md5" | resources.Minify | }} {{$contentIndex := resources.Get
"indices/contentIndex.json" | resources.Fingerprint "md5" | resources.Minify
}}
<script>
const SEARCH_ENABLED = {{.Site.Data.config.search.enableSemanticSearch}}
const LATEX_ENABLED = {{.Site.Data.config.enableLatex}}
const PRODUCTION = {{ hugo.IsProduction }}
const BASE_URL = {{.Site.BaseURL}}
const fetchData = Promise.all([
fetch("{{ $linkIndex.Permalink }}")
.then(data => data.json())
.then(data => ({
index: data.index,
links: data.links,
})),
fetch("{{ $contentIndex.Permalink }}")
.then(data => data.json()),
])
.then(([{index, links}, content]) => ({
index,
links,
content,
}))
const render = () => {
// NOTE: everything within this callback will be executed for every page navigation. This is a good place to put JavaScript that loads or modifies data on the page, adds event listeners, etc. If you are only dealing with basic DOM replacement, use the init function
const siteBaseURL = new URL(BASE_URL);
const pathBase = siteBaseURL.pathname;
const pathWindow = window.location.pathname;
const isHome = pathBase == pathWindow;
{{if $data.enableCodeBlockCopy | default $.Site.Data.config.enableCodeBlockCopy -}}
addCopyButtons();
{{ end }}
{{if $data.enableSPA | default $.Site.Data.config.enableSPA -}}
addTitleToCodeBlocks();
{{ end }}
{{if $data.enableCallouts | default $.Site.Data.config.enableCallouts -}}
addCollapsibleCallouts();
{{ end }}
{{if $data.enableLinkPreview | default $.Site.Data.config.enableLinkPreview}}
initPopover(
{{strings.TrimRight "/" .Site.BaseURL }},
{{$data.enableContextualBacklinks | default $.Site.Data.config.enableContextualBacklinks}}
)
{{end}}
{{if $data.enableFooter | default $.Site.Data.config.enableFooter}}
const footer = document.getElementById("footer")
if (footer) {
const container = document.getElementById("graph-container")
// retry if the graph is not ready
if (!container) return requestAnimationFrame(render)
// clear the graph in case there is anything within it
container.textContent = ""
const drawGlobal = isHome && {{$.Site.Data.graphConfig.enableGlobalGraph}};
drawGraph(
{{strings.TrimRight "/" .Site.BaseURL}},
drawGlobal,
{{$.Site.Data.graphConfig.paths}},
drawGlobal ? {{$.Site.Data.graphConfig.globalGraph}} : {{$.Site.Data.graphConfig.localGraph}}
);
}
{{end}}
{{if $data.enableMermaid | default $.Site.Data.config.enableMermaid}}
var els = document.getElementsByClassName("mermaid");
if (els.length > 0) {
import('https://unpkg.com/mermaid@9/dist/mermaid.esm.min.mjs').then(
(obj) => {
// init forces mermaid to render mermaid markdown without waiting
// for DOMContentLoaded event
obj.default.init();
}
)
}
{{end}}
// analytics
function clickHandler(evt) {
const target = evt.target
const classNames = target.className.split(" ")
const broken = classNames.includes("broken")
const internal = classNames.includes("internal-link")
plausible("Link Click", {
props: {
href: target.href,
broken,
internal,
graph: false,
}
})
}
const links = document.querySelectorAll("a")
for (link of links) {
if (link.className.includes("root-title")) {
link.addEventListener('click', clickHandler, {once: true})
}
}
}
const init = (doc = document) => {
// NOTE: everything within this callback will be executed for initial page navigation. This is a good place to put JavaScript that only replaces DOM nodes.
{{if $data.enableCodeBlockCopy | default $.Site.Data.config.enableCodeBlockCopy -}}
addCopyButtons();
{{ end }}
{{if $data.enableCodeBlockTitle | default $.Site.Data.config.enableCodeBlockTitle -}}
addTitleToCodeBlocks();
{{- end -}}
{{if $data.enableLatex | default $.Site.Data.config.enableLatex}}
renderMathInElement(doc.body, {
delimiters: [
{left: '$$', right: '$$', display: true},
{left: '$', right: '$', display: false},
],
macros: {
'': "'"
},
throwOnError : false
});
{{end}}
};
</script>
{{if $data.enableSPA | default $.Site.Data.config.enableSPA}}
{{ $router := resources.Get "js/router.js" | resources.Fingerprint "md5" |
resources.Minify }}
<script type="module">
import { attachSPARouting } from "{{$router.Permalink}}"
attachSPARouting(init, render)
</script>
{{else}}
<script>
window.Million = {
navigate: (url) => (window.location.href = url),
prefetch: () => {},
}
window.addEventListener("DOMContentLoaded", () => {
init()
render()
})
</script>
{{end}}
{{ $trimmedURL := trim (index (split .Site.BaseURL "://") 1) "/" }}
<script defer data-domain="{{$trimmedURL}}" src="https://plausible.io/js/script.js"></script>
<script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>
</head>
{{ template "_internal/google_analytics.html" . }}
{{ partial "popover.html" .}}

View File

@@ -0,0 +1,11 @@
<header>
{{ $config := cond (eq $.Site.Language.Lang "en") "config" (printf "config.%s" $.Site.Language.Lang) }}
<h1 id="page-title"><a class="root-title" href="{{ "" | absLangURL }}">{{ ( index $.Site.Data $config ).page_title | default $.Site.Data.config.page_title }}</a></h1>
<div class="spacer"></div>
<div id="search-icon">
<p>{{ i18n "search" }}</p>
<svg tabindex="0" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">{{ i18n "search_icon" }}</title><desc id="desc">{{ i18n "icon_search" }}</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"/><circle cx="8" cy="8" r="7"/></g></svg>
</div>
{{partial "darkmode.html" .}}
</header>

View File

@@ -0,0 +1,14 @@
{{if $.Site.Data.config.enableLatex}}
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.15.1/dist/katex.min.css" as="style"
onload="this.onload=null;this.rel='stylesheet'"
integrity="sha384-R4558gYOUz8mP9YWpZJjofhk+zx0AS11p36HnD2ZKj/6JR5z27gSSULCNHIRReVs" crossorigin="anonymous">
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.15.1/dist/katex.min.js"
integrity="sha384-z1fJDqw8ZApjGO3/unPWUPsIymfsJmyrDVWC8Tv/a1HeOtGmkwNd/7xUS0Xcnvsx"
crossorigin="anonymous"></script>
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.15.1/dist/contrib/auto-render.min.js"
integrity="sha384-+XBljXPPiv+OzfbB3cVmLHf4hdUFHlWNZN5spNQ7rmHTXpd7WvJum6fIACpNNfIR"
crossorigin="anonymous"></script>
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.2/dist/contrib/copy-tex.min.js"
integrity="sha384-ww/583aHhxWkz5DEVn6OKtNiIaLi2iBRNZXfJRiY1Ai7tnJ9UXpEsyvOITVpTl4A"
crossorigin="anonymous"></script>
{{end}}

View File

@@ -0,0 +1,8 @@
{{if $.Site.Data.config.enableMermaid}}
{{ if .Page.Store.Get "hasMermaid" }}
<script type="module">
import mermaid from 'https://unpkg.com/mermaid@9/dist/mermaid.esm.min.mjs';
mermaid.initialize({ startOnLoad: true });
</script>
{{ end }}
{{ end }}

View File

@@ -2,14 +2,19 @@
{{- range . -}}
<li class="section-li">
<div class="section">
<div class="desc">
<h3><a href="{{ .Permalink }}">{{- .Title -}}</a></h3>
<p>{{- .Summary -}}{{if .Truncated}}...{{end}}</p>
</div>
<p class="meta">
{{ .ReadingTime }} minute read. Last updated {{if ne .Date .Lastmod}}{{ .Lastmod.Format "January 2, 2006" }}{{else}}Unknown{{end}}
{{partial "date-fmt.html" .}}
</p>
<div class="desc">
<h3><a href="{{ .Permalink }}" class="internal-link" data-src="{{ .RelPermalink }}">{{- .Title -}}</a></h3>
</div>
<div class="spacer"></div>
<ul class="tags">
{{ range (.GetTerms "tags") }}
<li><a href="{{ .Permalink }}">{{ .LinkTitle | title}}</a></li>
{{ end }}
</ul>
</div>
</li>
{{- end -}}
</ul>
</ul>

View File

@@ -1,31 +0,0 @@
{{if $.Site.Data.config.enableLinkPreview}}
<script>
function htmlToElement(html) {
const template = document.createElement('template')
html = html.trim()
template.innerHTML = html
return template.content.firstChild
}
document.addEventListener("DOMContentLoaded", () => {
[...document.getElementsByClassName("internal-link")]
.forEach(li => {
const linkDest = content[li.dataset.src]
if (linkDest) {
const popoverElement = `<div class="popover">
<h3>${linkDest.title}</h3>
<p>${removeMarkdown(linkDest.content).split(" ", 15).join(" ")}...</p>
</div>`
const el = htmlToElement(popoverElement)
li.appendChild(el)
li.addEventListener("mouseover", () => {
el.classList.add("visible")
})
li.addEventListener("mouseout", () => {
el.classList.remove("visible")
})
}
})
})
</script>
{{end}}

View File

@@ -0,0 +1,12 @@
<div class="content-list">
<h2>{{ i18n "recent_notes" }}</h2>
<!--
You can also configure this to find related pages!
All you need to pass into the "page-list.html" partial
is a collection of pages.
https://gohugo.io/content-management/related/
-->
{{$notes := .Site.RegularPages.ByLastmod.Reverse}}
{{partial "page-list.html" (first 3 $notes)}}
</div>

View File

@@ -1,255 +1,18 @@
<div id="search-container">
<div id="search-space">
<input autocomplete="off" id="search-bar" name="search" type="text" aria-label="Search" placeholder="Search for something...">
<div id="results-container">
</div>
<div id="search-space">
<input autocomplete="off" id="search-bar" name="search" type="text" aria-label="{{ i18n "search" }}"
placeholder="{{ i18n "search_for_something" }}" dir="{{ $.Site.Language.LanguageDirection }}">
<div id="results-container">
</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/gh/nextapps-de/flexsearch@0.7.2/dist/flexsearch.bundle.js"></script>
<script>
// code from https://github.com/danestves/markdown-to-text
const removeMarkdown = (
markdown,
options = {
listUnicodeChar: false,
stripListLeaders: true,
gfm: true,
useImgAltText: false,
preserveLinks: false,
}
) => {
let output = markdown || "";
output = output.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm, "");
{{if $.Site.Data.config.search.enableSemanticSearch}}
{{ $js := resources.Get "js/semantic-search.js" | resources.ExecuteAsTemplate "js/semantic-search.js" . | resources.Fingerprint "md5" | resources.Minify }}
<script defer type="module" src="{{ $js.Permalink }}"></script>
{{else}}
<script src="https://cdn.jsdelivr.net/npm/flexsearch@0.7.21/dist/flexsearch.bundle.js"
integrity="sha256-i3A0NZGkhsKjVMzFxv3ksk0DZh3aXqu0l49Bbh0MdjE=" crossorigin="anonymous" defer></script>
{{ $js := resources.Get "js/full-text-search.js" | resources.Fingerprint "md5" | resources.Minify }}
<script defer src="{{ $js.Permalink }}"></script>
{{end}}
try {
if (options.stripListLeaders) {
if (options.listUnicodeChar)
output = output.replace(
/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm,
options.listUnicodeChar + " $1"
);
else output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, "$1");
}
if (options.gfm) {
output = output
.replace(/\n={2,}/g, "\n")
.replace(/~{3}.*\n/g, "")
.replace(/~~/g, "")
.replace(/`{3}.*\n/g, "");
}
if (options.preserveLinks) {
output = output.replace(/\[(.*?)\][\[\(](.*?)[\]\)]/g, "$1 ($2)")
}
output = output
.replace(/<[^>]*>/g, "")
.replace(/^[=\-]{2,}\s*$/g, "")
.replace(/\[\^.+?\](\: .*?$)?/g, "")
.replace(/\s{0,2}\[.*?\]: .*?$/g, "")
.replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g, options.useImgAltText ? "$1" : "")
.replace(/\[(.*?)\][\[\(].*?[\]\)]/g, "$1")
.replace(/^\s{0,3}>\s?/g, "")
.replace(/(^|\n)\s{0,3}>\s?/g, "\n\n")
.replace(/^\s{1,2}\[(.*?)\]: (\S+)( ".*?")?\s*$/g, "")
.replace(
/^(\n)?\s{0,}#{1,6}\s+| {0,}(\n)?\s{0,}#{0,} {0,}(\n)?\s{0,}$/gm,
"$1$2$3"
)
.replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
.replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
.replace(/(`{3,})(.*?)\1/gm, "$2")
.replace(/`(.+?)`/g, "$1")
.replace(/\n{2,}/g, "\n\n");
} catch (e) {
console.error(e);
return markdown;
}
return output;
};
</script>
<script>
const contentIndex = new FlexSearch.Document({
cache: true,
charset: "latin:extra",
optimize: true,
worker: true,
document: {
index: [{
field: "content",
tokenize: "strict",
context: {
resolution: 5,
depth: 3,
bidirectional: true
},
suggest: true,
}, {
field: "title",
tokenize: "forward",
}]
}
})
for (const [key, value] of Object.entries(content)) {
contentIndex.add({
id: key,
title: value.title,
content: removeMarkdown(value.content),
})
}
const highlight = (content, term) => {
const highlightWindow = 20
const tokenizedTerm = term.split(/\s+/).filter(t => t !== "")
const splitText = content.split(/\s+/).filter(t => t !== "")
const includesCheck = (token) => tokenizedTerm.some(term => token.toLowerCase().startsWith(term.toLowerCase()))
const occurrencesIndices = splitText
.map(includesCheck)
// calculate best index
let bestSum = 0
let bestIndex = 0
for (let i = 0; i < Math.max(occurrencesIndices.length - highlightWindow, 0); i++) {
const window = occurrencesIndices.slice(i, i + highlightWindow)
const windowSum = window.reduce((total, cur) => total + cur, 0)
if (windowSum >= bestSum) {
bestSum = windowSum
bestIndex = i
}
}
const startIndex = Math.max(bestIndex - highlightWindow, 0)
const endIndex = Math.min(startIndex + 2 * highlightWindow, splitText.length)
const mappedText = splitText
.slice(startIndex, endIndex)
.map(token => {
if (includesCheck(token)) {
return `<span class="search-highlight">${token}</span>`
}
return token
})
.join(" ")
.replaceAll('</span> <span class="search-highlight">', " ")
return `${startIndex === 0 ? "" : "..."}${mappedText}${endIndex === splitText.length ? "" : "..."}`
}
const resultToHTML = ({url, title, content, term}) => {
const text = removeMarkdown(content)
const resultTitle = highlight(title, term)
const resultText = highlight(text, term)
return `<button class="result-card" id="${url}">
<h3>${resultTitle}</h3>
<p>${resultText}</p>
</button>`
}
const redir = (id, term) => {
window.location.href = "{{.Site.BaseURL}}" + `${id}#:~:text=${encodeURIComponent(term)}`
}
const fetch = id => ({
id,
url: id,
title: content[id].title,
content: content[id].content
})
const source = document.getElementById('search-bar')
const results = document.getElementById("results-container")
let term
source.addEventListener("keyup", (e) => {
if (e.key === "Enter") {
const anchor = document.getElementsByClassName("result-card")[0]
redir(anchor.id, term)
}
})
source.addEventListener('input', (e) => {
term = e.target.value
contentIndex.search(term, [
{
field: "content",
limit: 10,
suggest: true,
},
{
field: "title",
limit: 5,
}
]).then(searchResults => {
const getByField = field => {
const results = searchResults.filter(x => x.field === field)
if (results.length === 0) {
return []
} else {
return [...results[0].result]
}
}
const allIds = new Set([...getByField('title'), ...getByField('content')])
const finalResults = [...allIds].map(fetch)
// display
if (finalResults.length === 0) {
results.innerHTML = `<button class="result-card">
<h3>No results.</h3>
<p>Try another search term?</p>
</button>`
} else {
results.innerHTML = finalResults
.map(result => resultToHTML({
...result,
term,
}))
.join("\n")
const anchors = document.getElementsByClassName("result-card");
[...anchors].forEach(anchor => {
anchor.onclick = () => redir(anchor.id, term)
})
}
})
})
const searchContainer = document.getElementById("search-container")
function openSearch() {
if (searchContainer.style.display === "none" || searchContainer.style.display === "") {
source.value = ""
results.innerHTML = ""
searchContainer.style.display = "block"
source.focus()
} else {
searchContainer.style.display = "none"
}
}
function closeSearch() {
searchContainer.style.display = "none"
}
document.addEventListener('keydown', (event) => {
if (event.key === "/") {
event.preventDefault()
openSearch()
}
if (event.key === "Escape") {
event.preventDefault()
closeSearch()
}
})
window.addEventListener('DOMContentLoaded', () => {
const searchButton = document.getElementById("search-icon")
searchButton.addEventListener('click', (evt) => {
openSearch()
})
searchButton.addEventListener('keydown', (evt) => {
openSearch()
})
searchContainer.addEventListener('click', (evt) => {
closeSearch()
})
document.getElementById("search-space").addEventListener('click', (evt) => {
evt.stopPropagation()
})
})
</script>

View File

@@ -0,0 +1,162 @@
{{ $content := .Content }}
{{ $raw := .RawContent }}
{{ $page := .Page }}
{{/* Escape slashes for Latex to fix line breaks */}}
{{$latex := findRE "(?:\\${2}([^\\$]+)\\${2})|(?:\\$([^\\$]*)\\$)" $content}}
{{range $latex}}
{{$fixed := replaceRE "\\\\(?: +|\\n)" "\\\\ " .}}
{{$content = replace $content . $fixed}}
{{end}}
{{/* Wikilinks */}}
{{$wikilinks := $content | findRE "!?\\[\\[\\S[^\\[\\]\\|]*(?:\\|[^\\[\\]]*)?\\S\\]\\]" }}
{{$codefences := $raw | findRE "\\x60[^\\x60\\n]+\\x60"}}
{{$codeblocks := $raw | findRE "\\x60{3}[^\\x60]+\\x60{3}"}}
{{$code := union $codefences $codeblocks}}
{{range $wikilinks}}
{{$cur := .}}
{{$incode := false}}
{{range $code}}
{{if (in . $cur)}}
{{$incode = true}}
{{end}}
{{end}}
{{if not $incode}}
<!-- remove link delimiters -->
{{$inner := . | strings.TrimPrefix "!" | strings.TrimPrefix "[[" | strings.TrimSuffix "]]" }}
<!-- split from alias -->
{{$split := split $inner "|"}}
<!-- separate link path -->
{{$path := index $split 0}}
{{$reference := split $path "#"}}
<!-- path with heading link removed -->
{{$title := index $reference 0}}
<!-- $display is hyperlink display text -->
<!-- use alias, else title -->
{{$display := default $title (index $split 1)}}
<!-- remove subfolder from title -->
{{$display := index (last 1 (split $display "/")) 0}}
<!-- attempt to get title -->
{{$searchtitle := $title }}
{{$curpage := $page.GetPage $searchtitle }}
<!-- attempt to search md file instead -->
{{ if (eq $curpage.String "nopPage") }}
{{$searchtitle = (add $title ".md") }}
{{$curpage = $page.GetPage $searchtitle }}
{{ end }}
<!-- attempt to reverse typographer behaviour -->
{{ if (eq $curpage.String "nopPage") }}
{{$searchtitle = (replace $searchtitle "&amp;" "&") }}
{{$searchtitle = (replace $searchtitle "&quot;" "\"") }}
{{$searchtitle = (replace $searchtitle "&rdquo;" "\"") }}
{{$searchtitle = (replace $searchtitle "&ldquo;" "\"") }}
{{$searchtitle = (replace $searchtitle "&rsquo;" "'") }}
{{$searchtitle = (replace $searchtitle "&lsquo;" "'") }}
{{$curpage = $page.GetPage $searchtitle }}
{{ end }}
{{$relpath := relURL $path}}
<!-- If path to Hugo page -->
{{if not (eq $curpage.String "nopPage") }}
{{$block := default "" (index $reference 1)}}
{{$block = strings.TrimRight "/" (cond (eq $block "") $block (printf "#%s" $block)) | urlize | lower}}
{{$href := strings.TrimRight "/" $curpage.RelPermalink}}
{{$link := printf "<a href=\"%s%s\" rel=\"noopener\" class=\"internal-link\" data-src=\"%s\">%s</a>" $href $block $href $display}}
{{$content = replace $content . $link}}
<!-- If path to existing file -->
{{else if fileExists $relpath}}
{{$splitpath := split $relpath "/"}}
{{$dirname := first (sub (len $splitpath) 1) $splitpath | path.Join | urlize}}
{{$basename := index (last 1 $splitpath) 0}}
{{$href := printf "/%s/%s" $dirname $basename}}
<!-- Embedded? -->
{{if (hasPrefix . "!")}}
{{ $embed_ext := lower (path.Ext $href) }}
<!-- Image -->
{{if in ".png .jpg .jpeg .gif .bmp .svg" $embed_ext }}
{{$width := default "auto" (index $split 1) }}
{{$link := printf "<img src=\"%s\" width=\"%s\" />" $href $width}}
{{$content = replace $content . $link}}
<!-- Video -->
{{else if in ".mp4 .webm .ogv .mov .mkv" $embed_ext}}
{{$link := printf "<video src=\"%s\" style=\"width: -webkit-fill-available;\" controls></video>" $href}}
{{$content = replace $content . $link}}
<!-- Audio -->
{{else if in ".mp3 .webm .wav .m4a .ogg .3gp .flac" $embed_ext}}
{{$link := printf "<audio src=\"%s\" controls></audio>" $href}}
{{$content = replace $content . $link}}
<!-- PDF -->
{{else if in ".pdf" $embed_ext }}
{{$src_link := printf "<a href=\"%s\" rel=\"noopener\" class=\"internal-link\">[source]</a>" $href}}
{{$iframe_link := printf "<iframe src=\"%s\" style=\"height: -webkit-fill-available; width: -webkit-fill-available;\"></iframe>" $href}}
{{$link := printf "%s<br>%s" $src_link $iframe_link}}
{{$content = replace $content . $link}}
<!-- other -->
{{else}}
{{$link := printf "<a href=\"%s\" rel=\"noopener\" class=\"internal-link\">%s</a>" $href $href}}
{{$content = replace $content . $link}}
{{end}}
{{else}}
{{$link := printf "<a href=\"%s\" rel=\"noopener\" class=\"internal-link\">%s</a>" $href $display}}
{{$content = replace $content . $link}}
{{end}}
<!-- Broken path -->
{{else}}
{{$link := printf "<a class=\"internal-link broken\">%s</a>" $display}}
{{$content = replace $content . $link}}
{{end}}
{{end}}
{{end}}
{{/* Add jumpable anchors */}}
{{ $content = $content | replaceRE "(<h[1-9] id=\"([^\"]+)\">)(.+)(</h[1-9]>)" `<a href="#${2}">${1}<span class="hanchor" ariaLabel="Anchor"># </span>${3}${4}</a>` }}
{{/* Callouts */}}
{{if $.Site.Data.config.enableCallouts}}
{{ $content = $content | replaceRE "<blockquote>" "<blockquote class=callout>" }}
{{ $blockquoteclasses := findRE `\[!.+\]` $content }}
{{ $blockquoteclasses1 := findRE "<blockquote.*?>(.|\n)*?</blockquote>" $content }}
{{ $blockquotetags := findRE `blockquote class=callout` $content }}
{{ $counter := 0 }}
{{ $counter1 := 0 }}
{{ $finder := index $blockquoteclasses1 $counter }}
{{range $blockquotetags}}
{{ $finder = index $blockquoteclasses1 $counter }}
{{ if (in $finder "[!") }}
{{ $inner := index $blockquoteclasses $counter1 }}
{{ if (in $finder "]-") }}
{{ $inner = $inner | replaceRE `\[!([a-zA-Z]+)\]` `callout-collapsible callout-collapsed ${1}`}}
{{ else if (in $finder "]+") }}
{{ $inner = $inner | replaceRE `\[!([a-zA-Z]+)\]` `callout-collapsible ${1}`}}
{{ else}}
{{ $inner = $inner | replaceRE `\[!([a-zA-Z]+)\]` `${1}` }}
{{ end }}
{{ $inner = printf "blockquote class=\"%s-callout\"" $inner | lower}}
{{ $content = replace $content . $inner 1}}
{{ $counter1 = add $counter1 1 }}
{{ else }}
{{ $inner := print "blockquote" }}
{{ $content = replace $content . $inner 1}}
{{ end }}
{{ $counter = add $counter 1 }}
{{end}}
{{ $content = $content | replaceRE `\[![a-zA-Z]+\][-\+]?` "" }}
{{ $content = $content | replaceRE "blockquote class=callout" "blockquote" }}
{{ $content = $content | replaceRE `(?s)(<blockquote class="\S+-callout">.*?)<br>(.*?<\/blockquote)` `${1}</p><p>${2}` }}
{{end}}
{{/* Make ==text== into <mark>text</mark> */}}
{{$mark := findRE "==([^=\n]+)==" $content}}
{{range $mark}}
{{$fixed := printf "<mark>%s</mark>" (replace . "==" "")}}
{{$content = replace $content . $fixed}}
{{end}}
{{ $content | safeHTML }}

View File

@@ -0,0 +1,9 @@
{{ $hasHeaders := gt (len (findRE "<h\\d.*?>(.|\n)*?</h\\d>" .Content)) 0 }}
{{ if (or (and (not $.Site.Data.config.enableToc) .Params.enableToc) (and $.Site.Data.config.enableToc (ne .Params.enableToc false) $hasHeaders)) }}
<aside class="mainTOC">
<details {{ if $.Site.Data.config.openToc }}open {{ end }}>
<summary>{{ i18n "toc" }}</summary>
{{ .TableOfContents }}
</details>
</aside>
{{end}}

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1012 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 17 KiB