-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
initial config from jupyterbook-template
- Loading branch information
Showing
26 changed files
with
1,434 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
hsa | ||
slippy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# https://EditorConfig.org | ||
|
||
root = true | ||
|
||
# Unix-style newlines with a newline ending every file | ||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[*.ipynb] | ||
# Content is json, but it seems to be minimally formatted | ||
indent_size = unset | ||
|
||
[*.js] | ||
indent_size = 2 | ||
|
||
[*.json] | ||
indent_size = 2 | ||
|
||
[*.md] | ||
indent_size = unset | ||
|
||
[*.py] | ||
# yapf and black will use indents other than 4 spaces | ||
indent_size = unset | ||
|
||
[*.rst] | ||
indent_size = unset | ||
|
||
[*.{yml,yaml}] | ||
indent_size = 2 | ||
max_line_length = 100 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: Deploy Website to GitHub Pages | ||
|
||
on: | ||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ["main"] | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
jobs: | ||
# Build JupyterBook Website | ||
build: | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
shell: bash -l {0} | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- name: Install Conda environment with Micromamba | ||
uses: mamba-org/setup-micromamba@v1 | ||
with: | ||
environment-file: environment.yml | ||
cache-environment: true | ||
|
||
- name: Build JupyterBook | ||
shell: bash -el {0} | ||
run: | | ||
./scripts/build_resources.sh | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v1 | ||
with: | ||
path: _build/html | ||
|
||
|
||
# Publish Website to GitHub Pages if built successfully | ||
deploy: | ||
needs: build | ||
if: github.ref == 'refs/heads/main' | ||
runs-on: ubuntu-latest | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
steps: | ||
- name: Setup Pages | ||
uses: actions/configure-pages@v3 | ||
|
||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,33 @@ | ||
# splashpage-template | ||
Template repository for event splash page only | ||
An event landing page built on a [Tech Conference Theme](https://themes.3rdwavemedia.com/demo/bs5/devconf/) | ||
|
||
For linked splashpage and JupyterBook see https://github.com/uwhackweek/jupyterbook-template | ||
|
||
## How to use this template | ||
|
||
You can use this template for your own event! | ||
|
||
1. Click the "Use this template" button at the top of the repo | ||
1. Select the account where you'd like to use the template. | ||
1. In your new repo, got to Settings --> Pages --> Source = GitHub Actions | ||
1. There are a few files you'll need to edit to customize content for your event: | ||
* `cookiecutter.yaml`: customize your landing page content | ||
1. Any commits pushed to the main branch will be published to GitHub Pages! | ||
|
||
## Build website locally | ||
|
||
First create an environment with necessary python packages | ||
``` | ||
cd [repository] | ||
mamba env create | ||
mamba activate splashpage | ||
``` | ||
|
||
Then run the build script | ||
``` | ||
./scripts/build_resources.sh | ||
``` | ||
|
||
## Details | ||
|
||
This template uses simple text YAML files to fill in key website details. [Cookiecutter](https://cookiecutter.readthedocs.io/en/stable/README.html) is then used to populate templated HTML for the final webpage. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
repo_directory: html | ||
name: UW Hackweek | ||
apply: | ||
url: '#' | ||
title: Application coming soon | ||
hackweek_mission: https://uwhackweek.github.io/hackweeks-as-a-service/mission.html | ||
banner: | ||
description: An awesome learning event. | ||
start_date: XX Month | ||
end_date: XX Month | ||
year: 2022 | ||
location: Seattle, WA | ||
links: | ||
- url: intro.html | ||
title: Event Jupyter Book | ||
new_window: false | ||
image: https://geohackweek.github.io/assets/images/banner.jpg | ||
# The opening session of the event with UTC offset | ||
event_countdown: "2024-08-07T08:30:00-07:00" | ||
about: | ||
description: Hackweeks are participant-driven events that strive to create | ||
welcoming spaces for participants to learn new things, build community and | ||
gain hands-on experience with collaboration and team science | ||
learn_more: https://escience.washington.edu/using-data-science/hackweeks | ||
links: | ||
- url: '#' | ||
title: A sample link | ||
new_window: True | ||
applicant_info: UW Hackweek 2022 will take place in October 2022 (virtual or in-person | ||
TBD). Applications have not yet opened, but should be anticipated in September 2022. | ||
team: | ||
!include team.yaml | ||
schedule: | ||
!include schedule.yaml | ||
sponsors: | ||
description: '' | ||
organizations: | ||
- name: eScience Institute | ||
website: '' | ||
logo_url: https://escience.washington.edu/wp-content/uploads/2015/10/Logo_eScience-stacked.png | ||
footer: | ||
social: | ||
- icon: github | ||
icon_pack: fab | ||
link: https://github.com/uwhackweek/ | ||
_copy_without_render: | ||
- assets | ||
_extensions: | ||
- jinja_markdown.MarkdownExtension |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: splashpage | ||
channels: | ||
- conda-forge | ||
dependencies: | ||
- pip | ||
- python=3.11 | ||
- cookiecutter | ||
# Dependencies of jinja-markdown: | ||
- jinja2>=2.11 | ||
- pygments>=2.6.1 | ||
- pymdown-extensions>=7.1 | ||
- pip: | ||
- jinja-markdown==1.210911 |
Oops, something went wrong.