generated from uwhackweek/splashpage-template
-
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.
- Loading branch information
0 parents
commit 7e7ae55
Showing
28 changed files
with
1,615 additions
and
0 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,11 @@ | ||
# To get started with Dependabot version updates, you'll need to specify which | ||
# package ecosystems to update and where the package manifests are located. | ||
# Please see the documentation for all configuration options: | ||
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: "github-actions" # See documentation for possible values | ||
directory: "/" # Location of package manifests | ||
schedule: | ||
interval: "weekly" |
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 Website | ||
build: | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
shell: bash -l {0} | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Install Conda environment with Micromamba | ||
uses: mamba-org/setup-micromamba@v1 | ||
with: | ||
environment-file: environment.yml | ||
cache-environment: true | ||
|
||
- name: Build Website | ||
shell: bash -el {0} | ||
run: | | ||
./scripts/build_resources.sh | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
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@v5 | ||
|
||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
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,144 @@ | ||
.DS_Store | ||
|
||
# Jupyter Book things | ||
.bash_history | ||
*_build | ||
.jupyter-server-log.txt | ||
.config/ | ||
.jupyter/ | ||
.local/ | ||
.viminfo | ||
|
||
# cookiecutter webpage things | ||
cookiecutter.json | ||
/book/_build/html/assets | ||
|
||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
pip-wheel-metadata/ | ||
share/python-wheels/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
MANIFEST | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.nox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
*.py,cover | ||
.hypothesis/ | ||
.pytest_cache/ | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
local_settings.py | ||
db.sqlite3 | ||
db.sqlite3-journal | ||
|
||
# Flask stuff: | ||
instance/ | ||
.webassets-cache | ||
|
||
# Scrapy stuff: | ||
.scrapy | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# IPython | ||
profile_default/ | ||
ipython_config.py | ||
|
||
# pyenv | ||
.python-version | ||
|
||
# pipenv | ||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. | ||
# However, in case of collaboration, if having platform-specific dependencies or dependencies | ||
# having no cross-platform support, pipenv may install dependencies that don't work, or not | ||
# install all needed dependencies. | ||
#Pipfile.lock | ||
|
||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow | ||
__pypackages__/ | ||
|
||
# Celery stuff | ||
celerybeat-schedule | ||
celerybeat.pid | ||
|
||
# SageMath parsed files | ||
*.sage.py | ||
|
||
# Environments | ||
.env | ||
.venv | ||
env/ | ||
venv/ | ||
ENV/ | ||
env.bak/ | ||
venv.bak/ | ||
|
||
# Spyder project settings | ||
.spyderproject | ||
.spyproject | ||
|
||
# Rope project settings | ||
.ropeproject | ||
|
||
# mkdocs documentation | ||
/site | ||
|
||
# mypy | ||
.mypy_cache/ | ||
.dmypy.json | ||
dmypy.json | ||
|
||
# Pyre type checker | ||
.pyre/ |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 University of Washington eScience Hackweeks | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,38 @@ | ||
# splashpage-template | ||
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 | ||
``` | ||
|
||
And preview your webpage! | ||
``` | ||
open _build/html/index.html | ||
``` | ||
|
||
## 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,53 @@ | ||
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: 2023 | ||
location: Seattle, WA | ||
# Add a button link right under the top (e.g. JupyterBook, url can be local file or https://) | ||
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 2023 will take place in October 2023 (virtual or in-person | ||
TBD). Applications have not yet opened, but should be anticipated in September 2023. | ||
# Redirect the site to a different domain. | ||
#redirect: | ||
# url: https://go.somehwere.else | ||
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.