Skip to content

Commit 8495a5d

Browse files
committed
setup initial static site
Signed-off-by: Derek Worthen <[email protected]>
1 parent 6e9bd55 commit 8495a5d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1348
-4
lines changed

.editorconfig

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Unix-style newlines with a newline ending every file
7+
[*]
8+
end_of_line = lf
9+
insert_final_newline = true
10+
charset = utf-8
11+
indent_style = space
12+
indent_size = 2
13+
14+
# 4 space indentation
15+
[*.py]
16+
indent_style = space
17+
indent_size = 4

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
_site
2+
.sass-cache
3+
.jekyll-cache
4+
.jekyll-metadata
5+
vendor

.post-template

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Article Title
3+
slug: url-friendly-article-name
4+
layout: page
5+
description: short description
6+
summary: >-
7+
Mulit-line Summary
8+
of the article
9+
image: assets/article-image.jpeg
10+
image-alt: image alt
11+
link: optional-external-link-used-by-cards
12+
---

404.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
layout: home
3+
title: 404
4+
description: Sorry, we couldn't find that page :(
5+
image: 'assets/lost.jpeg'
6+
---

Gemfile

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
gem "jekyll", "~> 4.2.2"
11+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
12+
gem "minima", "~> 2.5"
13+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
14+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
15+
# gem "github-pages", group: :jekyll_plugins
16+
# If you have any plugins, put them here!
17+
group :jekyll_plugins do
18+
gem "jekyll-feed", "~> 0.12"
19+
end
20+
21+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
22+
# and associated library.
23+
platforms :mingw, :x64_mingw, :mswin, :jruby do
24+
gem "tzinfo", "~> 1.2"
25+
gem "tzinfo-data"
26+
end
27+
28+
# Performance-booster for watching directories on Windows
29+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
30+
31+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
32+
# do not have a Java counterpart.
33+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
34+
35+
gem "webrick", "~> 1.7"
36+
37+
gem "jekyll-redirect-from", "~> 0.16.0"

Gemfile.lock

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.0)
5+
public_suffix (>= 2.0.2, < 5.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.1.10)
8+
em-websocket (0.5.3)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0)
11+
eventmachine (1.2.7)
12+
ffi (1.15.5)
13+
forwardable-extended (2.6.0)
14+
http_parser.rb (0.8.0)
15+
i18n (1.12.0)
16+
concurrent-ruby (~> 1.0)
17+
jekyll (4.2.2)
18+
addressable (~> 2.4)
19+
colorator (~> 1.0)
20+
em-websocket (~> 0.5)
21+
i18n (~> 1.0)
22+
jekyll-sass-converter (~> 2.0)
23+
jekyll-watch (~> 2.0)
24+
kramdown (~> 2.3)
25+
kramdown-parser-gfm (~> 1.0)
26+
liquid (~> 4.0)
27+
mercenary (~> 0.4.0)
28+
pathutil (~> 0.9)
29+
rouge (~> 3.0)
30+
safe_yaml (~> 1.0)
31+
terminal-table (~> 2.0)
32+
jekyll-feed (0.16.0)
33+
jekyll (>= 3.7, < 5.0)
34+
jekyll-redirect-from (0.16.0)
35+
jekyll (>= 3.3, < 5.0)
36+
jekyll-sass-converter (2.2.0)
37+
sassc (> 2.0.1, < 3.0)
38+
jekyll-seo-tag (2.8.0)
39+
jekyll (>= 3.8, < 5.0)
40+
jekyll-watch (2.2.1)
41+
listen (~> 3.0)
42+
kramdown (2.4.0)
43+
rexml
44+
kramdown-parser-gfm (1.1.0)
45+
kramdown (~> 2.0)
46+
liquid (4.0.3)
47+
listen (3.7.1)
48+
rb-fsevent (~> 0.10, >= 0.10.3)
49+
rb-inotify (~> 0.9, >= 0.9.10)
50+
mercenary (0.4.0)
51+
minima (2.5.1)
52+
jekyll (>= 3.5, < 5.0)
53+
jekyll-feed (~> 0.9)
54+
jekyll-seo-tag (~> 2.1)
55+
pathutil (0.16.2)
56+
forwardable-extended (~> 2.6)
57+
public_suffix (4.0.7)
58+
rb-fsevent (0.11.1)
59+
rb-inotify (0.10.1)
60+
ffi (~> 1.0)
61+
rexml (3.2.5)
62+
rouge (3.30.0)
63+
safe_yaml (1.0.5)
64+
sassc (2.4.0)
65+
ffi (~> 1.9)
66+
terminal-table (2.0.0)
67+
unicode-display_width (~> 1.1, >= 1.1.1)
68+
unicode-display_width (1.8.0)
69+
webrick (1.7.0)
70+
71+
PLATFORMS
72+
x86_64-linux
73+
74+
DEPENDENCIES
75+
http_parser.rb (~> 0.6.0)
76+
jekyll (~> 4.2.2)
77+
jekyll-feed (~> 0.12)
78+
jekyll-redirect-from (~> 0.16.0)
79+
minima (~> 2.5)
80+
tzinfo (~> 1.2)
81+
tzinfo-data
82+
wdm (~> 0.1.1)
83+
webrick (~> 1.7)
84+
85+
BUNDLED WITH
86+
2.3.19

README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,51 @@
1-
PyWhy’s mission is to build an open-source ecosystem for causal machine learning that moves forward the state-of-the-art and makes it available to practitioners and researchers. We build and host interoperable libraries, tools, and other resources spanning a variety of causal tasks and applications, connected through a common API on foundational causal operations and a focus on the end-to-end analysis process.
1+
# PyWhy static website (Jekyll)
22

3-
[Homepage on GitHub](https://github.com/py-why)
3+
This repo holds the source code and content to pywhy.org.
4+
5+
## Editing Content
6+
7+
For significant changes, follow [GitHub Flow](https://guides.github.com/introduction/flow/): create a new branch and submit a pull request to get review feedback from other team members. Once the PR is merged to main, the site will automatically rebuild and deploy.
8+
9+
The site is compiled using [Jekyll](https://jekyllrb.com/), so all of the content is written in [Markdown](https://daringfireball.net/projects/markdown/). In particular, Jekyll uses a superset of Markdown called Kramdown. [Syntax documentation here](https://kramdown.gettalong.org/syntax.html).
10+
11+
### File struture
12+
13+
The content is structured to avoid needing HTML editing for the site content. There are a few places content resides in order to be as obvious as possible while also adhering to Jekyll requirements.
14+
15+
- Main pages (root): any *.md files in the root of the project directory are top-level pages (except this README!). Most pages are Markdown except for the main home page (index.html) because it requires advanced HTML layout that Markdown does not support. *.md files will be converted to HTML files automatically for the deployment.
16+
- Content chunks [/content](./content): Fragments of markdown content to be included in other markdown or html pages. Content markdown files do not contain YAML Front Matter as they are not standalone pages.
17+
- Collections: represent types of content pages much like blog articles or news stories. Collections in this site include case studies articles (\_case_studies), learn content (\_learn), and news articles (\_news).
18+
19+
### YAML Front Matter
20+
21+
Every page has YAML front matter that gives Jekyll some instructions on how to process it:
22+
- title: displays a large-format title on the page.
23+
- layout: indicates what template should be used to render the page. Most pages will use the "page" template.
24+
- description: display a short description within cards.
25+
- summary: a longer summary of the resource displayed in aggregate view (news page, case studies page, etc).
26+
- image: optional large-format image to include in the layout beackground behind the title.
27+
- image-alt: alt attribute for the image and must be present for the image to be shown.
28+
- slug: url friendly name for the page.
29+
- link: An optional link to an external resource. If present, the link attribute indicates that the page/resource
30+
is external and generated cards and summaries will link out to the external resource instead of a local page.
31+
32+
## Editing the Site Locally
33+
34+
For deeper edits or site changes, you'll want to clone the repo and run Jekyll locally:
35+
36+
- Install [Docker](https://www.docker.com/get-started) for your platform and make sure it is running
37+
- Install [Docker Compose](https://docs.docker.com/compose/install/) for your platform
38+
- From a terminal, `cd` into the cloned repo directory and run `docker-compose up`
39+
40+
This will download the default Jekyll Docker container and spin up the Jekyll instance. Once it's ready (it might take a few minutes the first time), you can view the site at http://localhost:4000. The `docker-compose.yml` includes live reload config, so as you edit the site it will automatically refresh in your browser.
41+
42+
### Removing pages
43+
44+
If you need to remove a page, you'll want to redirect to preserve the links and prevent 404s for users that may have bookmarks.
45+
46+
Use the Jekyll [redirect plugin](https://github.com/jekyll/jekyll-redirect-from). If you choose a new page that the user should be directed to, you can add front matter to the new page that configures redirects, then delete the old page. It looks something like this:
47+
48+
```
49+
redirect_from:
50+
- /data-collection.html
51+
```
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Causes of Customer Churn/Attrition
3+
description: Predict causal effect from the intervention.
4+
image: assets/causes-of-customer-churn-attrition.jpg
5+
image-alt: Causes of Customer Churn/Attrition
6+
link: https://medium.com/geekculture/a-quickstart-for-causal-analysis-decision-making-with-dowhy-2ce2d4d1efa9
7+
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Effects of Home Visits on Infant Health (IHDP)
3+
description: Understanding the question of why.
4+
image: assets/effects-of-home-visits-on-infant-health.jpg
5+
image-alt: Effects of Home Visits on Infant Health (IHDP)
6+
link: https://towardsdatascience.com/implementing-causal-inference-a-key-step-towards-agi-de2cde8ea599
7+
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Optimizing Article Headlines
3+
description: Introducing the do-sampler for causal inference.
4+
image: assets/optimizing-article-headlines.png
5+
image-alt: Optimizing Article Headlines
6+
link: https://medium.com/@akelleh/introducing-the-do-sampler-for-causal-inference-a3296ea9e78d
7+
---

0 commit comments

Comments
 (0)