Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .eleventy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
module.exports = function (eleventyConfig) {
eleventyConfig.addShortcode("year", () => `${new Date().getFullYear()}`);
eleventyConfig.addPassthroughCopy("src/assets/images");
eleventyConfig.addPassthroughCopy({
"./src/site.webmanifest": "site.webmanifest",
});


return {
dir: {
input: "src",
data: "_data",
includes: "_includes",
layouts: "_layouts",
},
};
};
62 changes: 26 additions & 36 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,21 @@ on:
branches:
- main
paths:
# mkdocs source
- "src/**"
- "mkdocs.yml"
# poetry source
- "pyproject.toml"
- "poetry.lock"
# run updated workflows
- "package.json"
- "package-lock.json"
- "tailwind.config.js"
- "postcss.config.js"
- ".eleventy.js"
- ".github/workflows/**"
pull_request:
paths:
- "src/**"
- "mkdocs.yml"
- "pyproject.toml"
- "poetry.lock"
- "package.json"
- "package-lock.json"
- "tailwind.config.js"
- "postcss.config.js"
- ".eleventy.js"
- ".github/workflows/**"
workflow_dispatch:
inputs:
Expand Down Expand Up @@ -58,31 +59,27 @@ jobs:
- uses: actions/checkout@v4
with:
lfs: true # images are stored with LFS
# From: https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#caching-packages
- name: Install poetry
run: pipx install poetry==1.7.1
- uses: actions/setup-python@v5
- uses: actions/setup-node@v4
with:
python-version-file: .python-version
cache: poetry
# Install with --no-root because project does produce a python package
- run: poetry install --no-root
# From: https://github.com/squidfunk/mkdocs-material/blob/master/docs/publishing-your-site.md#with-github-actions
- name: Setup MkDocs cache
node-version-file: package.json
cache: "npm"
- name: Install node dependencies
run: npm install
- name: Setup site cache
uses: actions/cache@v3
with:
key: mkdocs-material-${{ github.run_id }}
path: .cache
key: build-11ty-${{ github.run_id }}
path: _site
restore-keys: |
mkdocs-material-
- name: Build site with MkDocs
run: poetry run mkdocs build
build-11ty-
- name: Build site with 11ty
run: npm run build
- name: Upload build artifact
id: upload
uses: actions/upload-artifact@v4
with:
name: ${{ env.artifact }}
path: site/
path: _site/
retention-days: 1

############################################################
Expand Down Expand Up @@ -138,17 +135,11 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- name: Install poetry # Needed for updating version in pyproject.toml
run: pipx install poetry==1.7.1
- name: List semantic release plugins
id: listPlugins
uses: mikefarah/yq@master
with:
cmd: yq '[ .plugins[] | .[0] // . ] | join(" ")' .releaserc
- name: Install Semantic Release
run: npm install -g semantic-release
- name: Install Semantic Release plugins
run: npm install -g ${{ steps.listPlugins.outputs.result }}
node-version-file: package.json
cache: "npm"
- name: Install node dependencies
run: npm install
- name: Run Semantic Release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -174,7 +165,6 @@ jobs:
# https://aka.ms/codeql-docs/language-support
language: [javascript-typescript]
steps:
- uses: actions/checkout@v4
- name: Download build artifact
uses: actions/download-artifact@v4
with:
Expand Down
1 change: 0 additions & 1 deletion .python-version

This file was deleted.

32 changes: 0 additions & 32 deletions .releaserc

This file was deleted.

47 changes: 13 additions & 34 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,26 @@
# Contributing

## Developing

- The site is maintained as an [MkDocs] website using the [Material for MkDocs] theme
- See [`mkdocs.yml`](./mkdocs.yml)
- The site source is contained in the [`src/`](./src/) directory
- This is configured in [`mkdocs.yml`](./mkdocs.yml)
- Differed from the default (`docs/`) to reflect that this site is not documentation
- Dependencies are managed using [Poetry] for Python
- See [`pyproject.toml`](./pyproject.toml)
- Common tasks are defined using [Taskfile](https://taskfile.dev/)
- See [`Taskfile.yml`](./Taskfile.yml)

## Testing
## Getting Started

The site can be tested locally using `mkdocs serve` once Python dependencies are installed.
To install the necessary packages, run this command in the root folder of the site:

```sh
# Install Python dependencies
poetry install --no-root

# Serve the site locally
poetry run mkdocs serve
npm install
```

The "serve" task can automatically perform these steps.
### Commands

```sh
# Run the "serve" task
task serve
```
- Run `npm start` for a development server and live reloading
- Run `npm run build` to generate a production build

## Deploying
## Developing

<!-- The site is deployed to a CloudFlare-managed domain using [CloudFlare Pages](https://developers.cloudflare.com/pages/). The guide [Deploy an MkDocs site to CloudFlare Pages](https://developers.cloudflare.com/pages/framework-guides/deploy-an-mkdocs-site/) was useful for setting this deployment up. -->
### Theme

- The site is deployed to [GitHub Pages] using [GitHub Actions]
- The custom domain "justenstall.com" is managed by CloudFlare
This site uses the [11ty-resume-template](https://github.com/learnwithgurpreet/11ty-resume-template) theme for 11ty. View the Theme Customization resource for information on how to customize the theme:

To trigger a deployment
- [Theme Customization](./docs/theme.md)

## Deploying

[MkDocs]: <https://www.mkdocs.org/> "MkDocs"
[Material for MkDocs]: <https://squidfunk.github.io/mkdocs-material/> "Material for MkDocs"
[Poetry]: <https://python-poetry.org/> "Poetry"
[GitHub Pages]: <https://docs.github.com/en/pages> "GitHub Pages"
[GitHub Actions]: <https://docs.github.com/en/actions> "GitHub Actions"
The site is deployed to GitHub Pages by a GitHub Actions Workflow.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

My portfolio and blog website, [justenstall.com](https://justenstall.com).

----
---

<a href="https://justenstall.com">
<img alt="GitHub Pages"
Expand All @@ -12,7 +12,13 @@ My portfolio and blog website, [justenstall.com](https://justenstall.com).
<img alt="Build Status"
src="https://img.shields.io/github/actions/workflow/status/justenstall/website/ci.yml?logo=github&labelColor=181717"/>
</a>
<a href="https://squidfunk.github.io/mkdocs-material/">
<img alt="Built with Material for MkDocs"
src="https://img.shields.io/badge/Material_for_MkDocs-526CFE?logo=MaterialForMkDocs&logoColor=white"/>
<a href="https://www.11ty.dev/">
<img alt="Built with 11ty"
src="https://img.shields.io/badge/built_with_11ty-black?logo=eleventy"/>
</a>
<!-- <a href="https://github.com/learnwithgurpreet/11ty-resume-template">
<img alt="Built with 11ty-resume-template"
src="https://img.shields.io/badge/11ty--resume--template-black?logo=eleventy"/>
</a> -->

<!-- // "eleventy-plugin-typeset": "github:arcades-studio/eleventy-plugin-typeset-again", -->
13 changes: 0 additions & 13 deletions SECURITY.md

This file was deleted.

Loading