Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: use zola #8

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
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
42 changes: 9 additions & 33 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,13 @@ on:
branches:
- main
paths:
# mkdocs source
- "src/**"
- "mkdocs.yml"
# poetry source
- "pyproject.toml"
- "poetry.lock"
# run updated workflows
- "theme/**"
- "config.toml"
- ".github/workflows/**"
pull_request:
paths:
- "src/**"
- "mkdocs.yml"
- "pyproject.toml"
- "poetry.lock"
- "theme/**"
- "config.toml"
- ".github/workflows/**"
workflow_dispatch:
inputs:
Expand Down Expand Up @@ -58,31 +51,16 @@ 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
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
uses: actions/cache@v3
with:
key: mkdocs-material-${{ github.run_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Build site with MkDocs
run: poetry run mkdocs build
- name: Build only
uses: shalzz/[email protected]
env:
BUILD_ONLY: true
- name: Upload build artifact
id: upload
uses: actions/upload-artifact@v4
with:
name: ${{ env.artifact }}
path: site/
path: public/
retention-days: 1

############################################################
Expand Down Expand Up @@ -138,8 +116,6 @@ 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
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "themes/dose"]
path = themes/dose
url = https://github.com/justenstall/dose.git
1 change: 0 additions & 1 deletion .python-version

This file was deleted.

47 changes: 0 additions & 47 deletions CONTRIBUTING.md

This file was deleted.

13 changes: 0 additions & 13 deletions SECURITY.md

This file was deleted.

18 changes: 18 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# The URL the site will be built for
base_url = "https://justenstall.com"

# Whether to automatically compile all Sass files in the sass directory
compile_sass = true

# Whether to build a search index to be used later on by a JavaScript library
build_search_index = true

theme = "dose"

[markdown]
# Whether to do syntax highlighting
# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
highlight_code = true

[extra]
# Put all your custom variables here
97 changes: 0 additions & 97 deletions mkdocs.yml

This file was deleted.

Loading