Skip to content

Commit 2f63b75

Browse files
codegraphtheorycodegraphtheory
committed
Add a github pages docsite
1 parent b25bf92 commit 2f63b75

File tree

21 files changed

+1634
-2
lines changed

21 files changed

+1634
-2
lines changed

‎.github/workflows/pages.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: actions/configure-pages@v5
23+
- uses: actions/jekyll-build-pages@v1
24+
with:
25+
source: ./docs
26+
destination: ./_site
27+
- uses: actions/upload-pages-artifact@v3
28+
with:
29+
path: ./_site
30+
31+
deploy:
32+
needs: build
33+
runs-on: ubuntu-latest
34+
environment:
35+
name: github-pages
36+
url: ${{ steps.deployment.outputs.page_url }}
37+
steps:
38+
- id: deployment
39+
uses: actions/deploy-pages@v4
40+

‎.gitignore‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,9 @@ __pycache__/
1010

1111
# macOS metadata
1212
.DS_Store
13-
data/
14-
outputs/
13+
14+
# Jekyll build artifacts
15+
docs/_site/
16+
docs/.jekyll-cache/
17+
docs/vendor/
18+
docs/.bundle/

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,20 @@ SET w.first_year = CASE
6464
END;
6565
```
6666

67+
## Documentation
68+
69+
Full documentation is available at the [project documentation site](https://graphtechnologydevelopers.github.io/english-words-knowledge-graph/).
70+
71+
To run the documentation site locally:
72+
73+
```bash
74+
cd docs
75+
bundle install --path vendor/bundle
76+
bundle exec jekyll serve --baseurl ""
77+
```
78+
79+
Visit `http://localhost:4000` to view the site locally.
80+
6781
## Share-Worthy Ideas
6882

6983
- Drop the GIF in language history threads (#linguistics #dataart).

‎docs/.ruby-version‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
3.0.0
2+

‎docs/Gemfile‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
ruby ">= 3.0.0"
6+
7+
gem "jekyll", "~> 4.3"
8+
gem "jekyll-seo-tag", "~> 2.8"
9+
gem "jekyll-sitemap", "~> 1.4"
10+

‎docs/Gemfile.lock‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.7)
5+
public_suffix (>= 2.0.2, < 7.0)
6+
base64 (0.3.0)
7+
bigdecimal (3.3.1)
8+
colorator (1.1.0)
9+
concurrent-ruby (1.3.5)
10+
csv (3.3.5)
11+
em-websocket (0.5.3)
12+
eventmachine (>= 0.12.9)
13+
http_parser.rb (~> 0)
14+
eventmachine (1.2.7)
15+
ffi (1.17.2)
16+
ffi (1.17.2-aarch64-linux-gnu)
17+
ffi (1.17.2-aarch64-linux-musl)
18+
ffi (1.17.2-arm-linux-gnu)
19+
ffi (1.17.2-arm-linux-musl)
20+
ffi (1.17.2-arm64-darwin)
21+
ffi (1.17.2-x86-linux-gnu)
22+
ffi (1.17.2-x86-linux-musl)
23+
ffi (1.17.2-x86_64-darwin)
24+
ffi (1.17.2-x86_64-linux-gnu)
25+
ffi (1.17.2-x86_64-linux-musl)
26+
forwardable-extended (2.6.0)
27+
google-protobuf (4.33.0)
28+
bigdecimal
29+
rake (>= 13)
30+
google-protobuf (4.33.0-aarch64-linux-gnu)
31+
bigdecimal
32+
rake (>= 13)
33+
google-protobuf (4.33.0-aarch64-linux-musl)
34+
bigdecimal
35+
rake (>= 13)
36+
google-protobuf (4.33.0-arm64-darwin)
37+
bigdecimal
38+
rake (>= 13)
39+
google-protobuf (4.33.0-x86-linux-gnu)
40+
bigdecimal
41+
rake (>= 13)
42+
google-protobuf (4.33.0-x86-linux-musl)
43+
bigdecimal
44+
rake (>= 13)
45+
google-protobuf (4.33.0-x86_64-darwin)
46+
bigdecimal
47+
rake (>= 13)
48+
google-protobuf (4.33.0-x86_64-linux-gnu)
49+
bigdecimal
50+
rake (>= 13)
51+
google-protobuf (4.33.0-x86_64-linux-musl)
52+
bigdecimal
53+
rake (>= 13)
54+
http_parser.rb (0.8.0)
55+
i18n (1.14.7)
56+
concurrent-ruby (~> 1.0)
57+
jekyll (4.4.1)
58+
addressable (~> 2.4)
59+
base64 (~> 0.2)
60+
colorator (~> 1.0)
61+
csv (~> 3.0)
62+
em-websocket (~> 0.5)
63+
i18n (~> 1.0)
64+
jekyll-sass-converter (>= 2.0, < 4.0)
65+
jekyll-watch (~> 2.0)
66+
json (~> 2.6)
67+
kramdown (~> 2.3, >= 2.3.1)
68+
kramdown-parser-gfm (~> 1.0)
69+
liquid (~> 4.0)
70+
mercenary (~> 0.3, >= 0.3.6)
71+
pathutil (~> 0.9)
72+
rouge (>= 3.0, < 5.0)
73+
safe_yaml (~> 1.0)
74+
terminal-table (>= 1.8, < 4.0)
75+
webrick (~> 1.7)
76+
jekyll-sass-converter (3.1.0)
77+
sass-embedded (~> 1.75)
78+
jekyll-seo-tag (2.8.0)
79+
jekyll (>= 3.8, < 5.0)
80+
jekyll-sitemap (1.4.0)
81+
jekyll (>= 3.7, < 5.0)
82+
jekyll-watch (2.2.1)
83+
listen (~> 3.0)
84+
json (2.15.2)
85+
kramdown (2.5.1)
86+
rexml (>= 3.3.9)
87+
kramdown-parser-gfm (1.1.0)
88+
kramdown (~> 2.0)
89+
liquid (4.0.4)
90+
listen (3.9.0)
91+
rb-fsevent (~> 0.10, >= 0.10.3)
92+
rb-inotify (~> 0.9, >= 0.9.10)
93+
mercenary (0.4.0)
94+
pathutil (0.16.2)
95+
forwardable-extended (~> 2.6)
96+
public_suffix (6.0.2)
97+
rake (13.3.1)
98+
rb-fsevent (0.11.2)
99+
rb-inotify (0.11.1)
100+
ffi (~> 1.0)
101+
rexml (3.4.4)
102+
rouge (4.6.1)
103+
safe_yaml (1.0.5)
104+
sass-embedded (1.93.3)
105+
google-protobuf (~> 4.31)
106+
rake (>= 13)
107+
sass-embedded (1.93.3-aarch64-linux-android)
108+
google-protobuf (~> 4.31)
109+
sass-embedded (1.93.3-aarch64-linux-gnu)
110+
google-protobuf (~> 4.31)
111+
sass-embedded (1.93.3-aarch64-linux-musl)
112+
google-protobuf (~> 4.31)
113+
sass-embedded (1.93.3-arm-linux-androideabi)
114+
google-protobuf (~> 4.31)
115+
sass-embedded (1.93.3-arm-linux-gnueabihf)
116+
google-protobuf (~> 4.31)
117+
sass-embedded (1.93.3-arm-linux-musleabihf)
118+
google-protobuf (~> 4.31)
119+
sass-embedded (1.93.3-arm64-darwin)
120+
google-protobuf (~> 4.31)
121+
sass-embedded (1.93.3-riscv64-linux-android)
122+
google-protobuf (~> 4.31)
123+
sass-embedded (1.93.3-riscv64-linux-gnu)
124+
google-protobuf (~> 4.31)
125+
sass-embedded (1.93.3-riscv64-linux-musl)
126+
google-protobuf (~> 4.31)
127+
sass-embedded (1.93.3-x86_64-darwin)
128+
google-protobuf (~> 4.31)
129+
sass-embedded (1.93.3-x86_64-linux-android)
130+
google-protobuf (~> 4.31)
131+
sass-embedded (1.93.3-x86_64-linux-gnu)
132+
google-protobuf (~> 4.31)
133+
sass-embedded (1.93.3-x86_64-linux-musl)
134+
google-protobuf (~> 4.31)
135+
terminal-table (3.0.2)
136+
unicode-display_width (>= 1.1.1, < 3)
137+
unicode-display_width (2.6.0)
138+
webrick (1.9.1)
139+
140+
PLATFORMS
141+
aarch64-linux-android
142+
aarch64-linux-gnu
143+
aarch64-linux-musl
144+
arm-linux-androideabi
145+
arm-linux-gnu
146+
arm-linux-gnueabihf
147+
arm-linux-musl
148+
arm-linux-musleabihf
149+
arm64-darwin
150+
riscv64-linux-android
151+
riscv64-linux-gnu
152+
riscv64-linux-musl
153+
ruby
154+
x86-linux-gnu
155+
x86-linux-musl
156+
x86_64-darwin
157+
x86_64-linux-android
158+
x86_64-linux-gnu
159+
x86_64-linux-musl
160+
161+
DEPENDENCIES
162+
jekyll (~> 4.3)
163+
jekyll-seo-tag (~> 2.8)
164+
jekyll-sitemap (~> 1.4)
165+
166+
RUBY VERSION
167+
ruby 3.4.7p58
168+
169+
BUNDLED WITH
170+
2.7.2

‎docs/_config.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Site Configuration
2+
title: English Lexicon Time Machine
3+
description: Watch the entire English language blossom from Wiktionary + Google Books N-grams, rendered as a living, breathing prefix galaxy.
4+
lang: en
5+
6+
# GitHub Pages Configuration
7+
# For project sites: url is https://{username}.github.io, baseurl is /{repository-name}
8+
# For user/org sites: url is https://{username}.github.io, baseurl is ""
9+
# GitHub Pages will override these if GitHub Pages is enabled, but set them explicitly for local dev
10+
url: https://graphtechnologydevelopers.github.io
11+
baseurl: /english-words-knowledge-graph
12+
13+
permalink: /:path/
14+
markdown: kramdown
15+
highlighter: rouge
16+
17+
# Plugins
18+
plugins:
19+
- jekyll-seo-tag
20+
- jekyll-sitemap
21+
22+
# Markdown settings
23+
kramdown:
24+
input: GFM
25+
hard_wrap: false
26+
toc_levels: 2..4
27+
28+
# SEO and Social
29+
twitter:
30+
username: codegraph
31+
32+
# Defaults: make .md files use page layout
33+
defaults:
34+
- scope:
35+
path: ""
36+
type: "pages"
37+
values:
38+
layout: page
39+
- scope:
40+
path: ""
41+
type: "posts"
42+
values:
43+
layout: page
44+

‎docs/_includes/footer.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<footer class="site-footer">
2+
<nav aria-label="Footer">
3+
<a href="https://github.com/GraphTechnologyDevelopers">GitHub org</a>
4+
<a href="https://graphtech.dev/">Community hub</a>
5+
<a href="https://x.com/i/communities/1977449294861881612">X community</a>
6+
<a href="https://github.com/codegraphtheory">CodeGraphTheory (GitHub)</a>
7+
<a href="http://x.com/codegraph">CodeGraph (X)</a>
8+
<a href="http://x.com/graphtheory">GraphTheory (X)</a>
9+
</nav>
10+
</footer>
11+

‎docs/_includes/head.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<meta charset="utf-8" />
2+
<meta name="viewport" content="width=device-width, initial-scale=1" />
3+
<link rel="canonical" href="{{ page.url | absolute_url }}" />
4+
<link rel="stylesheet" href="{{ "/assets/css/styles.css" | relative_url }}" />
5+
{% seo %}
6+
<script defer src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
7+

‎docs/_layouts/default.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!doctype html>
2+
<html lang="{{ site.lang | default: 'en' }}">
3+
<head>{% include head.html %}</head>
4+
<body>
5+
<a class="skip-link" href="#main">Skip to content</a>
6+
<header class="site-header">
7+
<a class="brand" href="{{ site.baseurl | default: '/' }}">{{ site.title }}</a>
8+
</header>
9+
<main id="main" class="container">{{ content }}</main>
10+
{% include footer.html %}
11+
<script src="{{ "/assets/js/main.js" | relative_url }}" defer></script>
12+
</body>
13+
</html>
14+

0 commit comments

Comments
 (0)