Skip to content

Commit

Permalink
0.3.0 mobile,print,style fixes + docs
Browse files Browse the repository at this point in the history
  • Loading branch information
metaory committed Sep 21, 2024
1 parent ed8dc39 commit c286458
Show file tree
Hide file tree
Showing 10 changed files with 167 additions and 128 deletions.
79 changes: 54 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
<div align="center">
<img height="200" src="https://raw.githubusercontent.com/metaory/jsonresume-theme-legacy/master/src/assets/logo.svg">
<h5>JSONRESUME-THEME-LEGACY</h5>
<h4>
<a href="https://metaory.github.io/jsonresume-theme-legacy">
metaory.github.io/jsonresume-theme-legacy
</a>
</h4>
<h3>JSONRESUME-THEME-LEGACY</h3>
<h4><a href="https://metaory.github.io/jsonresume-theme-legacy">LIVE DEMO</a></h4>
</div>

---

<div align="center">
<h4>SAMPLE</h4>
<a href="sample.pdf">view</a> / <a href="sample.pdf">download<a>
<img src="https://raw.githubusercontent.com/metaory/jsonresume-theme-legacy/master/screenshot.png">
</div>

Expand Down Expand Up @@ -59,18 +57,22 @@ Customization
Icons
-----

[Iconify](https://icon-sets.iconify.design) is used for icons.

The default icon map is defined in [src/pages/index.json](https://github.com/metaory/jsonresume-theme-legacy/blob/master/src/pages/index.json)
> [!Note]
> [Iconify](https://icon-sets.iconify.design) is used for icons.
Under `meta.themeOptions.iconMap`
> [!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`
You can add/overwrite by adding the desired key value in your `private.json`
> [!Tip]
> You can add/overwrite by adding the desired key value in your `private.json`
You can use icons from any collection;
> [!Tip]
> You can use icons from any collection
For example to add new icon for keyword `system-design` to have `mingcute:ghost-line` icon, and to
overwrite the `javascript` icon
For example to add new icon
for keyword `system-design` to have `mingcute:ghost-line` icon,
and to overwrite the `javascript` icon;

```jsonc
{
Expand All @@ -87,7 +89,7 @@ overwrite the `javascript` icon
}
```

> [!Note]
> [!Important]
> Make sure the keys in `iconMap` are all lowercase
>
> While the keyword do NOT have to be lowercase
Expand All @@ -98,35 +100,62 @@ overwrite the `javascript` icon
> - `hugeicons:ai-view`
> - `hugeicons--ai-view`
> [!Tip]
> [!Caution]
> a complete process restart is needed if overwriting existing icons
---

Colors
Images
------

You can overwrite color values
> [!Tip]
> Image paths can be remote or local
>
> Local path is from root
Under `meta.themeOptions.colors`
```jsonc
{
"basics": {
"name": "John Doe",
"label": "Programmer",
// remote images
"image": "https://avatars.githubusercontent.com/u/9919",
// local private ignored assets
"logo": "/.dev/my-private-logo.png",
// ...
},
// ...
}
```

- [ ] TODO
---

Colors
------

> [!Tip]
> ~~You can overwrite color values~~
>
> ~~Under `meta.themeOptions.colors`~~
>
> 🚧 Not implemented
---

Titles
------

You can section titles

Under `meta.themeOptions.sectionTitles`
> [!Tip]
> You can change section titles
>
> Under `meta.themeOptions.sectionTitles`
---

Troubleshooting
---------------

> [!Tip]
> [!Caution]
> You need the dev script running before running the pdf build script
---
Expand All @@ -144,7 +173,7 @@ Troubleshooting
> [!Note]
> Only tested on Linux
>
> Reconsider your life choices if you're running Windows 💩
> ⚠️ Reconsider your life choices if you're running Windows!!! 💩
---

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jsonresume-theme-legacy",
"version": "0.2.1",
"version": "0.3.0",
"description": "✱ Legacy handlebars jsonresume theme port to vite",
"author": "metaory <metaory@gmail.com>",
"bugs": "https://github.com/metaory/jsonresume-theme-legacy/issues",
Expand Down
Binary file modified sample.pdf
Binary file not shown.
Binary file modified screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/bg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 14 additions & 14 deletions src/assets/bg.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/components/projects.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
{{#each projects}}
<section class="project-item auto-break-before">
{{#if @first}}
<span />
<span> </span>
{{ else }}
{{> components/hr.hbs }}
{{/if}}
Expand Down
Loading

0 comments on commit c286458

Please sign in to comment.