diff --git a/README.md b/README.md new file mode 100644 index 0000000..82cadae --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# Bruno Mikoski Portfolio + +This README provides instructions for managing the portfolio content and structure. + +## Managing Works Items + +### Creating a New Portfolio Item +1. Create a new subfolder in the `/content/works` directory +2. Inside the new subfolder, create an `index.md` file +3. Add project images to the subfolder: + - Thumbnail image must be named `thumb.jpg`, `thumb.png`, or `thumb.webp` + - All other images in this folder will be included in the project gallery (alphabetically sorted) +4. In `index.md`, add the following parameters: + ```markdown + --- + title: "Project Title" + tags: ["tag1", "tag2"] + year: YYYY + role: "Your Role" + language: "Project Language(s)" + platforms: "Platform(s)" + youtube: "YouTube video link (if applicable)" + --- + + Project description goes here. + ``` + +### Updating a Works Item +1. Navigate to the project's subfolder in `/content/works` +2. Edit the `index.md` file to update text content or parameters +3. Replace or add images as needed + +### Deleting a Works Item +1. Remove the project's subfolder from `/content/works` + +## Key File Locations + +- Contact Page Content: `/content/contact.html` +- Main Template Files: `/themes/bruno/layouts/` +- Static Files (CSS, JS): `/themes/bruno/assets/` + +## Template Code Locations + +- Home Page (Works List): `/themes/bruno/layouts/_default/home.html` +- Project Details: `/themes/bruno/layouts/works/single.html` +- Generic Single Page: `/themes/bruno/layouts/_default/single.html` +- Contact Page Wrapper: `/themes/bruno/layouts/_default/contact.html` + +## Creating New Pages + +1. Create a new Markdown file in the `/content/` directory (e.g., `newpage.md`) +2. Add front matter to the file: + ```markdown + --- + title: "New Page Title" + layout: "page" + --- + + Page content goes here. + ``` +3. Create a corresponding template in `/themes/bruno/layouts/_default/` if needed (e.g., `page.html`) +4. The new page will be accessible at `/newpage/` + +## Project Structure + +- `/content/`: Contains all the content files (works, pages) +- `/themes/bruno/`: Contains the theme files + - `/layouts/`: HTML templates + - `/_default/`: Default templates + - `/works/`: Work-specific templates + - `/assets/`: Static files (CSS, JS, images) + +## Additional Notes + +- The contact page can be edited in the `contact.html` file inside the `/content/` folder +- Make sure to optimize images before adding them to the project to ensure fast loading times +- The works single page template (`/themes/bruno/layouts/works/single.html`) includes: + - Project details + - YouTube video embedding (if applicable) + - Image gallery + - Related projects section (based on tags, filled with random projects if needed) +- Regularly backup your content and theme files + +For any questions or issues, please refer to the project documentation or contact the maintainer. diff --git a/themes/bruno/layouts/_default/single.html b/themes/bruno/layouts/_default/single.html index 41c8d20..4472c8b 100644 --- a/themes/bruno/layouts/_default/single.html +++ b/themes/bruno/layouts/_default/single.html @@ -1,84 +1,6 @@ {{ define "main" }} -
-

{{ .Title }}

- +
+

{{ .Title }}

{{ .Content }} - - - {{ if .Params.youtube }} - {{ $youtubeID := replaceRE "^.*youtu\\.be/(.*)$" "${1}" .Params.youtube }} -
- -
- {{ end }} - - - {{ if .Params.language }} - {{ if .Params.platforms }} -
-

Language: {{ .Params.language }}

-

Platforms: {{ .Params.platforms }}

-
- {{ end }} - {{ end }} -
- - -
- - {{ $jpgImages := .Resources.Match "*.jpg" }} - {{ $pngImages := .Resources.Match "*.png" }} - {{ $webpImages := .Resources.Match "*.webp" }} - {{ $images := union (union $jpgImages $pngImages) $webpImages }} - {{ if $images }} - {{ range $images }} - - {{ $ext := path.Ext .Name }} - {{ if and (or (eq $ext ".jpg") (eq $ext ".png") (eq $ext ".webp") (eq $ext ".jpeg")) (not (hasPrefix .Name "thumb.")) }} - {{ $.Title }} - Image - {{ end }} - {{ end }} - {{ end }} -
- - - {{ $currentPage := . }} - - {{ $related := where (where .Site.RegularPages "Type" "works") "Permalink" "ne" .Permalink | shuffle | first 3 }} - {{ if $related }} -
- -
- {{ range $index, $element := $related }} -
- - - {{ $thumbBase := path.Join .File.Dir "thumb" }} - {{ $jpgPath := printf "%s.jpg" $thumbBase }} - {{ $pngPath := printf "%s.png" $thumbBase }} - {{ $webpPath := printf "%s.webp" $thumbBase }} - - {{ $thumbnailPath := "" }} - {{ if (fileExists $webpPath) }} - {{ $thumbnailPath = $webpPath }} - {{ else if (fileExists $jpgPath) }} - {{ $thumbnailPath = $jpgPath }} - {{ else if (fileExists $pngPath) }} - {{ $thumbnailPath = $pngPath }} - {{ else }} - {{ $thumbnailPath = "/images/placeholder.jpg" }} - {{ end }} - Thumbnail of project {{ .Title }} -

{{ .Title }}

- - {{ with .Params.year }} -

{{ . }}

- {{ end }} - -
- {{ end }} -
-
- {{ end }} + {{ end }} \ No newline at end of file diff --git a/themes/bruno/layouts/works/single.html b/themes/bruno/layouts/works/single.html new file mode 100644 index 0000000..2a44b1b --- /dev/null +++ b/themes/bruno/layouts/works/single.html @@ -0,0 +1,104 @@ +{{ define "main" }} +
+

{{ .Title }}

+ + {{ .Content }} + + + {{ if .Params.youtube }} + {{ $youtubeID := replaceRE "^.*youtu\\.be/(.*)$" "${1}" .Params.youtube }} +
+ +
+ {{ end }} + + + {{ if .Params.language }} + {{ if .Params.platforms }} +
+

Language: {{ .Params.language }}

+

Platforms: {{ .Params.platforms }}

+
+ {{ end }} + {{ end }} +
+ + +
+ + {{ $jpgImages := .Resources.Match "*.jpg" }} + {{ $pngImages := .Resources.Match "*.png" }} + {{ $webpImages := .Resources.Match "*.webp" }} + {{ $images := union (union $jpgImages $pngImages) $webpImages }} + {{ if $images }} + {{ range $images }} + + {{ $ext := path.Ext .Name }} + {{ if and (or (eq $ext ".jpg") (eq $ext ".png") (eq $ext ".webp") (eq $ext ".jpeg")) (not (hasPrefix .Name "thumb.")) }} + {{ $.Title }} - Image + {{ end }} + {{ end }} + {{ end }} +
+ + + {{ $currentPage := . }} + {{ $relatedProjects := slice }} + + + {{ range .Params.tags }} + {{ $tag := . }} + {{ $taggedProjects := where (where $currentPage.Site.RegularPages "Type" "works") "Params.tags" "intersect" (slice $tag) }} + {{ $relatedProjects = $relatedProjects | union $taggedProjects }} + {{ end }} + + + {{ $relatedProjects = where $relatedProjects "Permalink" "ne" $currentPage.Permalink }} + + + {{ $relatedProjects = $relatedProjects | shuffle | first 3 }} + + + {{ $remainingCount := sub 3 (len $relatedProjects) }} + {{ if gt $remainingCount 0 }} + {{ $randomProjects := where (where .Site.RegularPages "Type" "works") "Permalink" "ne" $currentPage.Permalink | shuffle | first $remainingCount }} + {{ $relatedProjects = $relatedProjects | union $randomProjects }} + {{ end }} + + {{ if $relatedProjects }} +
+ +
+ {{ range $index, $element := $relatedProjects }} +
+ + + {{ $thumbBase := path.Join .File.Dir "thumb" }} + {{ $jpgPath := printf "%s.jpg" $thumbBase }} + {{ $pngPath := printf "%s.png" $thumbBase }} + {{ $webpPath := printf "%s.webp" $thumbBase }} + + {{ $thumbnailPath := "" }} + {{ if (fileExists $webpPath) }} + {{ $thumbnailPath = $webpPath }} + {{ else if (fileExists $jpgPath) }} + {{ $thumbnailPath = $jpgPath }} + {{ else if (fileExists $pngPath) }} + {{ $thumbnailPath = $pngPath }} + {{ else }} + {{ $thumbnailPath = "/images/placeholder.jpg" }} + {{ end }} + Thumbnail of project {{ .Title }} +

{{ .Title }}

+ + {{ with .Params.year }} +

{{ . }}

+ {{ end }} + +
+ {{ end }} +
+
+ {{ end }} +{{ end }} \ No newline at end of file