Skip to content

Commit 5bc1a82

Browse files
Fill the creating a template section
1 parent 37ee9a5 commit 5bc1a82

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ and generate a PDF from it.
66
![A preview of Resume Stack in the browser](https://raw.githubusercontent.com/lucafaggianelli/resume-stack/main/docs/images/browser-window.png)
77

88
🖐 Don't forget to 🌟 star this repo if you like it!
9-
109
💥 More templates are coming!
1110

1211
## 🤷‍♀️ What's a stack?
@@ -160,7 +159,7 @@ advanced features than plain CSS, you're not obliged to use it
160159
though!
161160

162161
For more information on how to customize these files, check the
163-
section [Creating a template](#👩‍🎨-creating-a-template)
162+
section [Creating a template](#-creating-a-template)
164163

165164
## 🌟 Automatic PDF Export
166165

@@ -201,3 +200,17 @@ manually enabled:
201200
for creating the releases
202201

203202
## 👩‍🎨 Creating a template
203+
204+
> A more detailed guide on how to create templates is coming
205+
206+
The `index.html` file support is an [AlpineJS](https://alpinejs.dev/) template,
207+
check their website for the syntax.
208+
209+
The resume content is available as the `resume` variable in the AlpineJS template.
210+
211+
You can use [TailwindCSS](https://tailwindcss.com/) classes and custom CSS/SCSS
212+
styles, just modify the `styles/main.scss` or create a new file and import it
213+
in `main.scss`.
214+
215+
The Resume Designer is setup automatically, it picks the CSS variables defined
216+
in `main.scss`, you can add other variables to the rule `:root[designer-params] {}`.

0 commit comments

Comments
 (0)