Skip to content

Commit

Permalink
0110_2317
Browse files Browse the repository at this point in the history
  • Loading branch information
metaory committed Jan 10, 2025
1 parent 01dd9f2 commit 9575068
Showing 1 changed file with 32 additions and 39 deletions.
71 changes: 32 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<div align="center">
<img height="200" src="https://raw.githubusercontent.com/metaory/jsonresume-theme-legacy/master/src/assets/logo.svg">
<h4>JSONRESUME-THEME-LEGACY</h4>
<h4><a href="https://metaory.github.io/jsonresume-theme-legacy">LIVE DEMO</a></h4>
</div>

---

<div align="center">
<h1>
<img valign="middle" height="28" src="https://raw.githubusercontent.com/metaory/jsonresume-theme-legacy/master/src/assets/logo.svg">
𐍰⌄𐌒⌃𐣯𐐹
</h1>
<i><small>jsonresume theme</small></i><br>
<a href="https://metaory.github.io/jsonresume-theme-legacy">demo</a> |
<a href="sample.pdf">sample.pdf</a>
<img src="screenshot.png" />
</div>

<p align="center">
<img src="screenshot.png" width="70%" />
</p>

---

USAGE
=====
## USAGE

```sh
# clone
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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`~~
Expand All @@ -159,8 +153,7 @@ Colors
---

Troubleshooting
---------------
### Troubleshooting

> [!CAUTION]
> You need the dev script running before running the pdf build script
Expand All @@ -177,13 +170,13 @@ Troubleshooting
---

> [!Note]
> [!NOTE]
> Only tested on Linux
>
> Reconsider your life choices if you're running 💩 Windows!
---

License
-------
## LICENSE

[MIT](LICENSE)

0 comments on commit 9575068

Please sign in to comment.