From 9575068e6f2b565cf25d2de7ca2183b3314c64f9 Mon Sep 17 00:00:00 2001 From: metaory Date: Fri, 10 Jan 2025 23:17:47 +0800 Subject: [PATCH] 0110_2317 --- README.md | 71 +++++++++++++++++++++++++------------------------------ 1 file changed, 32 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 5d798b9..7abf252 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@
- -

JSONRESUME-THEME-LEGACY

-

LIVE DEMO

-
- ---- - -
+

+ + 𐍰⌄𐌒⌃𐣯𐐹 +

+ jsonresume theme
+ demo | sample.pdf -
+

+ +

+ --- -USAGE -===== +## USAGE ```sh # clone @@ -50,23 +50,21 @@ pnpm run build:private --- -Customization -------------- +## CUSTOMIZATION -Icons ------ +### Icons -> [!Note] +> [!NOTE] > [Iconify](https://icon-sets.iconify.design) is used for icons. -> [!Note] +> [!NOTE] > The default icon map is defined in [src/pages/index.json](https://github.com/metaory/jsonresume-theme-legacy/blob/master/src/pages/index.json) > Under `meta.themeOptions.iconMap` -> [!Tip] +> [!TIP] > You can add/overwrite by adding the desired key value in your `private.json` -> [!Tip] +> [!TIP] > You can use icons from any collection For example to add new icon @@ -88,26 +86,25 @@ and to overwrite the `javascript` icon; } ``` -> [!Important] +> [!IMPORTANT] > Make sure the keys in `iconMap` are all lowercase > > While the keyword do NOT have to be lowercase -> [!Tip] +> [!TIP] > the iconify icon name can be in either form > > - `hugeicons:ai-view` > - `hugeicons--ai-view` -> [!Caution] +> [!CAUTION] > a complete process restart is needed if overwriting existing icons --- -Images ------- +### Images -> [!Tip] +> [!TIP] > Image paths can be remote or local > > Local path is from root @@ -129,28 +126,25 @@ Images --- -Summary -------- +### Summary -> [!Tip] +> [!TIP] > The `basics.summary` is placed as **raw HTML** --- -Titles ------- +### Titles -> [!Tip] +> [!TIP] > You can change section titles > > Under `meta.themeOptions.sectionTitles` --- -Colors ------- +### Colors -> [!Tip] +> [!TIP] > ~~You can overwrite color values~~ > > ~~Under `meta.themeOptions.colors`~~ @@ -159,8 +153,7 @@ Colors --- -Troubleshooting ---------------- +### Troubleshooting > [!CAUTION] > You need the dev script running before running the pdf build script @@ -177,13 +170,13 @@ Troubleshooting --- -> [!Note] +> [!NOTE] > Only tested on Linux > > Reconsider your life choices if you're running 💩 Windows! --- -License -------- +## LICENSE + [MIT](LICENSE)