Skip to content

Commit

Permalink
feat: wip
Browse files Browse the repository at this point in the history
  • Loading branch information
cjshearer committed Nov 1, 2024
1 parent 0aa3a69 commit 3d07af5
Show file tree
Hide file tree
Showing 26 changed files with 430 additions and 340 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# modern-hugo-resume

A responsive, minimal, print-friendly resume builder. Powered by Hugo, Tailwind CSS, Paged.js, Nix, and GitHub Pages.
A responsive, minimal, hugo-theme. Powered by Hugo, Nix, and GitHub Pages.

_Host your own resume on GitHub for free!_
_Host your site on GitHub for free!_

## Quick Start

This guide helps you quickly test the theme and deploy your resume to github pages. If you like it, we suggest continuing with the [Extended Setup](#extended-setup).
This guide helps you quickly test the theme and deploy your site to github pages. If you like it, we suggest continuing with the [Extended Setup](#extended-setup).

### 1. Fork this repository

Expand All @@ -20,12 +20,12 @@ Under `(your repo) > Settings > Pages > Build and Deployment > Source`, select "

Go to `(your repo) > Actions` and click "Enable workflows". These are disabled by default on forks, to prevent unintended workflow runs.

### 4. Deploy your Customized Resume
### 4. Deploy your Customized Site

Edit the resume at `(your repo) > exampleSite/content/_index.md` using the github editor. When you commit it, the resume site will automatically be built and deployed to `https://<your_username>.github.io`.
Edit the content at `(your repo) > exampleSite/content/_index.md` using the github editor. When you commit it, the site will automatically be built and deployed to `https://<your_username>.github.io`.

> [!TIP]
> You can skip editing the resume and trigger the build and deploy workflow manually by going to `Actions > ./github/workflows/deploy.yaml` and clicking "run workflow".
> You can skip editing the content and trigger the build and deploy workflow manually by going to `Actions > ./github/workflows/deploy.yaml` and clicking "run workflow".
## Extended Setup

Expand Down Expand Up @@ -119,9 +119,8 @@ git push

These can be installed manually, or automatically with [nix](https://nixos.org/download/) by running `nix develop`:

1. Install [`hugo`](https://gohugo.io/installation/) >= 1.28.0+extended.
2. Install [`go`](https://go.dev/dl/) >= 1.22.3.
3. Install [`tailwindcss`](https://github.com/tailwindlabs/tailwindcss/releases) >= 3.4.4.
1. Install [`hugo`](https://gohugo.io/installation/) v0.135.0+extended.
2. Install [`go`](https://go.dev/dl/) v1.22.7.

### Common Commands
```sh
Expand All @@ -131,4 +130,10 @@ nix flake check # run formatter/linter checks, exactly the same way it's done in

hugo server # serve to localhost and rebuild changes automatically
hugo --minify # build static site for production
```
```

## Parameters

Some features and data are configurable via Hugo's parameters

TODO
158 changes: 158 additions & 0 deletions assets/main.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
/* TODO: study caching for GetRemote to see if we can fetch this during nix build */
@import url("https://cdn.jsdelivr.net/npm/modern-normalize/modern-normalize.min.css") layer(base);
@layer base, components, utilities;
@layer base {
:root {
--color-background: #fff;
--color-body: #1f2937;
--color-headings: #111827;
--color-link-hover: var(--color-body);
--color-link: inherit;
--color-invert-background: #262626;
--color-invert-body: #d1d5db;
--color-invert-headings: #fff;
--color-invert-link-hover: #f3f4f6;
--color-invert-link: inherit;

--font-size-base: 1.75rem;
--font-size-lg: 1.875rem;
--font-size-2xl: 2.375rem;
--font-size-3xl: 2.5rem;

@media (prefers-color-scheme: dark) {
--color-background: var(--color-invert-background);
--color-body: var(--color-invert-body);
--color-headings: var(--color-invert-headings);
--color-link-hover: var(--color-invert-link-hover);
--color-link: var(--color-invert-link);
}
}

html {
font-size: 62.5%;
}

body {
background-color: var(--color-background);
color: var(--color-body);
font-size: 1.6rem;
margin-left: auto;
margin-right: auto;
max-width: var(--page-width);
padding: var(--page-margin);

@media not all and (min-width: 640px) {
padding: 1.625rem;
}
}

h1,
h2,
h3,
h4,
h5,
h6,
strong {
color: var(--color-headings);
margin-bottom: 1.875rem;
margin-top: 2.375rem;
line-height: 1.25;
break-after: avoid;
}

h1 {
font-size: var(--font-size-3xl);
font-weight: 600;
}

h2 {
border-bottom: 1px solid;
font-size: var(--font-size-2xl);
font-weight: 600;
padding-bottom: 1.375rem;
}

h3 {
font-size: var(--font-size-lg);
font-weight: 600;
}

h4,
h5,
h6,
a,
p,
li {
font-size: var(--font-size-base);
font-weight: 400;
line-height: 1.875rem;
}

p,
ul,
ol {
margin-bottom: 1.875rem;
break-inside: avoid;
}

ul {
list-style-type: disc;
padding-inline-start: 2.25rem;

ul {
list-style-type: circle;
margin-bottom: 1.375rem;
margin-top: 1.375rem;
}

> li {
margin-bottom: 1.125rem;
margin-top: 1.125rem;
padding-inline-start: 1.25rem;
}
}

a {
color: var(--color-link);
text-decoration-line: underline;
text-underline-offset: 0.375rem;

&:hover {
color: var(--color-link-hover);
}
}

header > nav > ul {
align-items: baseline;

> li:first-child {
flex-grow: 1;

> a {
font-size: var(--font-size-2xl);
font-weight: 600;
text-decoration-line: none;
}
}
}
footer {
padding-top: 2.375rem;
}
}

@layer components {
.inline-list {
display: flex;
flex-wrap: wrap;
gap: 1.375rem;
list-style-type: none;
padding-left: 0;

> li {
margin-bottom: 0;
margin-top: 0;
padding-inline-start: 0;
white-space: nowrap;
}
}
}
152 changes: 0 additions & 152 deletions assets/tailwind.css

This file was deleted.

3 changes: 1 addition & 2 deletions biome.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"$schema": "https://biomejs.dev/schemas/1.8.1/schema.json",
"$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
"css": {
"formatter": {
"enabled": true,
"indentStyle": "space"
}
},
Expand Down
Loading

0 comments on commit 3d07af5

Please sign in to comment.