Skip to content

Commit 92343d5

Browse files
ikreymerikreymer
authored
Site reorg: Remove site/ subpath (#306)
Unfortunately, for proper package pathing, need to remove the `site/` subpath. This includes: - Moving everything back into root - Adding a `copy-site.sh` script to copy resources into `mkdocs/site/` before building the site with mkdocs. - Also update examples to ensure all are loading the local sw.js / ui.js - Consolidate examples in `docs/examples` - Consolidate assets under src/assets/ - Move `favicons` to root - Reformat and relint - Tests: update playwright tests to use mkdocs output, add test for embed in docs - bump to 2.0.0-beta.2
1 parent fcd59b6 commit 92343d5

File tree

82 files changed

+181
-139
lines changed

Some content is hidden

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

82 files changed

+181
-139
lines changed

‎.eslintrc.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,11 @@ module.exports = {
103103
ignorePatterns: [
104104
"__generated__",
105105
"__mocks__",
106+
"mkdocs/_genhtml",
106107
"dist",
107108
"ruffle",
108-
"ui.js",
109-
"sw.js",
109+
"**/ui.js",
110+
"**/sw.js",
110111
],
111112
overrides: [
112113
{

‎.github/workflows/integration.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,10 @@ jobs:
2929
- name: Playwright Install Browsers
3030
run: yarn playwright install
3131

32+
- uses: actions/setup-python@v4
33+
with:
34+
python-version: 3.x
35+
- run: pip install -r mkdocs/requirements.txt
36+
3237
- name: Playwright Run Tests
3338
run: yarn run playwright test

‎.github/workflows/site-publish.yaml‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,8 @@ jobs:
2626
- name: Yarn Install
2727
run: yarn install --frozen-lockfile
2828

29-
- name: Yarn Build
30-
run: yarn build
31-
3229
- uses: actions/setup-python@v4
3330
with:
3431
python-version: 3.x
35-
- run: pip install mkdocs-macros-plugin mkdocs-redirects mkdocs-material
36-
- run: cd mkdocs && mkdocs gh-deploy --force
32+
- run: pip install -r mkdocs/requirements.txt
33+
- run: yarn run publish-docs

‎.gitignore‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1+
**/sw.js
2+
**/ui.js
13
*.har
24
*.warc
35
*.warc.gz
4-
!site/examples/*.warc
56
**/node_modules
67
yarn-error.log
78
coverage/
89
**/local-examples/
910
**/.DS_Store
1011
**/.sass-cache/
1112
**/__pycache__/
12-
mkdocs/_genhtml/
1313
dist/
1414
plugins-*/
15-
site/sw.js
16-
site/ui.js
17-
site/favicons/
18-
.jekyll-cache
19-
15+
!mkdocs/site/docs/examples/*.warc
16+
mkdocs/_genhtml/
17+
mkdocs/site/index.html
18+
mkdocs/site/embed.html
19+
mkdocs/site/webmanifest.json
20+
mkdocs/site/favicons
21+
mkdocs/site/ruffle
2022
ipfs-core.min.js

‎CHANGES.md‎

Lines changed: 6 additions & 0 deletions

‎README.md‎

Lines changed: 1 addition & 1 deletion

‎site/embed.html‎ renamed to ‎embed.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
background-color: lightgrey;
77
}
88
</style>
9-
<link rel="icon" href="/favicons/favicon.ico" sizes="32x32">
10-
<link rel="icon" href="/favicons.favicon.svg" type="image/svg+xml">
11-
<link rel="apple-touch-icon" href="/favicons/apple-touch-icon.png">
9+
<link rel="icon" href="/favicons/favicon.ico" sizes="32x32" />
10+
<link rel="icon" href="/favicons.favicon.svg" type="image/svg+xml" />
11+
<link rel="apple-touch-icon" href="/favicons/apple-touch-icon.png" />
1212
</head>
1313
<body>
1414
<replay-web-page
1515
replaybase="./"
1616
embed="replay-with-info"
17-
src="./docs/assets/tweet-example.wacz"
17+
src="./docs/examples/tweet-example.wacz"
1818
url="page:0"
1919
></replay-web-page>
2020
</body>

‎src/assets/favicons/apple-touch-icon.png‎ renamed to ‎favicons/apple-touch-icon.png‎

File renamed without changes.

‎src/assets/favicons/favicon.ico‎ renamed to ‎favicons/favicon.ico‎

File renamed without changes.

‎site/docs/assets/brand/favicon.svg‎ renamed to ‎favicons/favicon.svg‎

File renamed without changes.

0 commit comments

Comments
 (0)