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

Website: Migrate to vitepress #6518

Closed
wants to merge 96 commits into from
Closed
Show file tree
Hide file tree
Changes from 86 commits
Commits
Show all changes
96 commits
Select commit Hold shift + click to select a range
ba438d9
Commit first version of vue-based rendering system
Pandapip1 Feb 17, 2023
7dcf0bc
Make more changes to try to get build to work
Pandapip1 Feb 17, 2023
3d90436
Commit some changes so far
Pandapip1 Feb 17, 2023
f47f5b3
More syntax highlighting fixes
Pandapip1 Feb 17, 2023
3f8d23a
Fix some package lock stuff
Pandapip1 Feb 17, 2023
8592b2a
Commit fixes
Pandapip1 Feb 17, 2023
776bb55
Fix citation format
Pandapip1 Feb 17, 2023
ef1c49a
Commit a lot of stuff. Not all of it is completely done.
Pandapip1 Feb 17, 2023
1bdd65f
Finished product!
Pandapip1 Feb 17, 2023
26a6216
Fix some rendering bugs
Pandapip1 Feb 17, 2023
e4c2dd2
Replace htmlproofer with build website
Pandapip1 Feb 17, 2023
9e1802e
Rename build website to htmlproofer so that CI passes
Pandapip1 Feb 17, 2023
f3d388f
Never mind, it'll need a manual merge anyway :laugh:
Pandapip1 Feb 17, 2023
a5a10c0
Really dum mistakes
Pandapip1 Feb 17, 2023
f55e1b4
Add caching
Pandapip1 Feb 17, 2023
68eee13
Fix subtle linking error
Pandapip1 Feb 17, 2023
e4eb72e
Remove extra newline
Pandapip1 Feb 17, 2023
ebdd4d1
Build fixed
Pandapip1 Feb 17, 2023
bcd205f
Fix bug with JD json
Pandapip1 Feb 17, 2023
44ada97
A crucial step missing
Pandapip1 Feb 17, 2023
1086bde
Fix some stuff related to meta
Pandapip1 Feb 17, 2023
2521ea4
Fix odd alignment issue
Pandapip1 Feb 17, 2023
10cc263
Fix random centering
Pandapip1 Feb 17, 2023
17f4cd6
Fix removal of centering
Pandapip1 Feb 17, 2023
bd6280f
Aesthetics: add linebreak before badges
Pandapip1 Feb 18, 2023
b719647
Even more aesthetics
Pandapip1 Feb 18, 2023
ea6296c
More aesthetics
Pandapip1 Feb 18, 2023
55c8bc2
Make a "minor" change (to all EIPs)
Pandapip1 Feb 18, 2023
5f97e28
Code review, RSS and Atom feeds, and a favicon
Pandapip1 Feb 18, 2023
656af5a
Commit changes so far (RSS filtering is broken)
Pandapip1 Feb 18, 2023
18d4ddc
Split date formatting into separate function
Pandapip1 Feb 18, 2023
e41e122
Somehow this fixes the rss + atom feeds
Pandapip1 Feb 19, 2023
6b44031
Fix typo in regex
Pandapip1 Feb 19, 2023
1e21a4a
Re-add final and living tags
Pandapip1 Feb 19, 2023
6ac6df9
Update EIP-5757: Move to living and update EIP-1 requirements
Pandapip1 Feb 19, 2023
6e4b80c
Merge branch 'use-vue' of https://github.com/Pandapip1/EIPs into use-vue
Pandapip1 Feb 19, 2023
8e0d821
Add vscode to gitignore
Pandapip1 Feb 19, 2023
137562a
Use rust syntax for regexes.
Pandapip1 Feb 19, 2023
fc35d50
Reusable listings
Pandapip1 Feb 19, 2023
071e7b9
Fix favicon and some other stuff
Pandapip1 Feb 19, 2023
aa35e2e
Fix some theming errors
Pandapip1 Feb 19, 2023
9c61e27
Merge branch 'ethereum:master' into use-vue
Pandapip1 Feb 19, 2023
a406030
Fix bug with Final label
Pandapip1 Feb 19, 2023
b0dd9f2
Merge branch 'use-vue' of https://github.com/Pandapip1/EIPs into use-vue
Pandapip1 Feb 19, 2023
3c30316
PWA + better modularity
Pandapip1 Feb 19, 2023
3525186
Force vitepress to copy all assets
Pandapip1 Feb 19, 2023
696783a
Fix assets directory not being copied
Pandapip1 Feb 19, 2023
bba5b7e
Fix missing image errors in manifest
Pandapip1 Feb 19, 2023
1deb0fe
Improve peer review message
Pandapip1 Feb 19, 2023
6d3c18e
Add finalized entry to preamble
Pandapip1 Feb 19, 2023
0b64994
Completely revamp front page
Pandapip1 Feb 19, 2023
bd633fe
Remove duplicate "home" link from navbar
Pandapip1 Feb 19, 2023
ccfdc90
Add fancy editor list
Pandapip1 Feb 19, 2023
96fc574
Fix typo in index
Pandapip1 Feb 19, 2023
f047b09
Split EIP rendering into separate files
Pandapip1 Feb 19, 2023
5e31784
Basic search functionality
Pandapip1 Feb 20, 2023
6d1d8e8
Better search
Pandapip1 Feb 20, 2023
69508b5
Screw it, I'm using google search
Pandapip1 Feb 20, 2023
faad519
Fix minor styling issue
Pandapip1 Feb 20, 2023
1e83b73
Hacky custom search bar
Pandapip1 Feb 20, 2023
defa1f2
Fix incorrect search terming
Pandapip1 Feb 20, 2023
b03fc03
Really *really* hacky search bar
Pandapip1 Feb 20, 2023
60237c6
Ah, forgot a critical step
Pandapip1 Feb 20, 2023
18d785c
Race condition
Pandapip1 Feb 20, 2023
27e260f
Finally fixed???
Pandapip1 Feb 20, 2023
0309b52
You asked for this, @SamWilsn
Pandapip1 Feb 21, 2023
b965c8c
This thing is a memory hog and a half wow
Pandapip1 Feb 21, 2023
04ada2e
Fix search?
Pandapip1 Feb 21, 2023
bc7bed5
Shockingly poor man's search
Pandapip1 Feb 22, 2023
419bfeb
I regret nothing now!
Pandapip1 Feb 22, 2023
68ec6d6
Merge branch 'master' into use-vue
Pandapip1 Feb 22, 2023
8ce5945
Fix search
Pandapip1 Feb 22, 2023
a4cdc9e
Fix another bug with the search widget
Pandapip1 Feb 22, 2023
5b364a2
Allow escaping in search queries
Pandapip1 Feb 22, 2023
f801112
Fix escaping logic
Pandapip1 Feb 22, 2023
49770d4
Some more bug fixes
Pandapip1 Feb 22, 2023
9750cd2
Improved search box
Pandapip1 Feb 22, 2023
3fdf783
Fix formatting
Pandapip1 Feb 22, 2023
a15db7a
Merge branch 'master' into use-vue
Pandapip1 Feb 24, 2023
e3392ab
Merge branch 'master' into use-vue
Pandapip1 Feb 25, 2023
946e2b4
@fulldecent -inspired filters
Pandapip1 Feb 27, 2023
4243df7
Merge branch 'master' into use-vue
Pandapip1 Mar 8, 2023
c243905
Patch to automatically fetch EIP from title
Pandapip1 Mar 29, 2023
5a3950c
Merge branch 'master' of https://github.com/ethereum/EIPs into use-vue
Pandapip1 Mar 29, 2023
7d8a6fd
Forgot to stage EIP-5252
Pandapip1 Mar 29, 2023
62b775a
Remove old RSS feeds
Pandapip1 Mar 29, 2023
bd8f7c1
Fix a typo
Pandapip1 May 14, 2023
b203327
Delete unused file
Pandapip1 May 14, 2023
a3d24e2
Merge branch 'master' of https://github.com/ethereum/EIPs into use-vue
Pandapip1 May 14, 2023
cc4dff5
Commit changes so far (currently broken)
Pandapip1 May 15, 2023
b41c938
Oops typo
Pandapip1 May 15, 2023
6d6f05a
Typo 2 electric boogaloo
Pandapip1 May 15, 2023
6ed7921
Fix EIP-107 (maybe that's the problem?)
Pandapip1 May 15, 2023
cb8e7b7
Speed up build a lot
Pandapip1 May 15, 2023
00e7916
Add additional checks
Pandapip1 May 15, 2023
67a6a88
Add additional optimization
Pandapip1 May 15, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
41 changes: 27 additions & 14 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,30 +36,43 @@ jobs:
name: pr_number
path: pr/

htmlproofer:
name: HTMLProofer
build:
name: Build Website
runs-on: ubuntu-20.04

steps:
- name: Checkout EIP Repository
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
with:
fetch-depth: 0 # Required for git diff to work

- name: Install Ruby
uses: ruby/setup-ruby@08245253a76fa4d1e459b7809579c62bd9eb718a
- name: Install NodeJS
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
with:
ruby-version: 2.6.0
bundler-cache: true
node-version: 16
cache: npm

- name: Build Website
run: |
bundle exec jekyll doctor
bundle exec jekyll build
- name: Install Packages
run: npm ci

- name: HTML Proofer
run: bundle exec htmlproofer ./_site --check-html --check-opengraph --report-missing-names --log-level=:debug --assume-extension --empty-alt-ignore --timeframe=6w --disable-external
Comment on lines -58 to -59
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like you're turning off the "check links in the final rendered output" (HTMLProofer) check, so we'd be relying on the markdown link checker entirely. Is my understanding correct, and is that what we want?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, since we want to remove all ruby stuff. If you want, I can put in a new action that runs htmlproofer against the built website.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I'm sure there's a better option than htmlproofer if we're moving away from Ruby.

- name: Restore Cached Data
id: cache-vitepress-restore
uses: actions/cache/restore@v3
with:
path: .vitepress/cache
key: vitepress-cache-v1

- name: DNS Validator
run: bundle exec github-pages health-check
- name: Build Website
run: |
export NODE_ENV=production
export NODE_OPTIONS=--max_old_space_size=6144
npm run build

- name: Upload Website Artifact
uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce
with:
name: website
path: .vitepress/dist
SamWilsn marked this conversation as resolved.
Show resolved Hide resolved

link-check:
name: Link Check
Expand Down
65 changes: 65 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Deploy to GitHub Pages
on:
workflow_dispatch:
inputs:
branch:
description: Branch to deploy
required: true
default: master
push:
branches:
- master

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout EIPs Repository (workflow_dispatch)
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
if: github.event_name == 'workflow_dispatch'
with:
fetch-depth: 0
ref: ${{ github.event.inputs.branch }}
- name: Checkout EIPs Repository (push)
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
if: github.event_name == 'push'
with:
fetch-depth: 0
- name: Setup NodeJS
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
with:
node-version: 16
cache: npm
- name: Install Packages
run: npm ci
- name: Restore Cached Data
id: cache-vitepress-restore
uses: actions/cache/restore@v3
with:
path: .vitepress/cache
key: vitepress-cache-v1
- name: Build Website
run: |
export NODE_ENV=production
export NODE_OPTIONS=--max_old_space_size=6144
npm run build
Pandapip1 marked this conversation as resolved.
Show resolved Hide resolved
- name: Configure GitHub Pages
uses: actions/configure-pages@fc89b04e7d263ef510d9e77d3a1d088fb2688522
- name: Create GitHub Pages Artifact
uses: actions/upload-pages-artifact@253fd476ed429e83b7aae64a92a75b4ceb1a17cf
with:
path: .vitepress/dist
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@0243b6c10d06cb8e95ed8ee471231877621202c0
- name: Cache Data
uses: actions/cache/save@v3
with:
path: .vitepress/cache
key: vitepress-cache-v1
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,14 @@ vendor

# Secrets
.vercel

# Node
node_modules

# Vitepress
.vitepress/cache
.vitepress/dist
.vitepress/.temp

# VSCode
.vscode
Loading