-
-
Notifications
You must be signed in to change notification settings - Fork 88
Fix GitHub Pages workflow #275
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
Closed
Closed
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
8a7439e
Fix GitHub Pages workflow
vjik eb07258
fix
vjik dc35b6a
Update translation
vjik b95d8d7
fix
vjik 2c47f0b
Merge remote-tracking branch 'origin/fix-gh-pages' into fix-gh-pages
vjik 0246774
fix
vjik 323d53e
fix
vjik 7224385
Merge remote-tracking branch 'origin/master' into fix-gh-pages
vjik 1dae517
fix
vjik f0ca2ad
fix
vjik ebf1d88
fix
vjik 95f81d5
fix
vjik 19f9ff1
fix
vjik 381f8f3
fix
vjik 5457c00
fix
vjik 517005a
fix
vjik 991677f
Update translation
vjik 8118b7c
improve
vjik 576d3d8
Merge remote-tracking branch 'origin/fix-gh-pages' into fix-gh-pages
vjik 608565c
fix
vjik 49f6799
fix
vjik c61849d
fix
vjik f60fd95
fix
vjik 0e35f56
fix
vjik 03bca62
fix
vjik deb3890
fix
vjik 28bd57d
improve
vjik c998b10
Update translation
vjik 027211c
improve
vjik 88281ce
Merge remote-tracking branch 'origin/fix-gh-pages' into fix-gh-pages
vjik 625dc32
fix
vjik 65899cb
fix
vjik 2fe51d5
fix
vjik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -12,3 +12,6 @@ trim_trailing_whitespace = true | |
|
|
||
| [*.md] | ||
| trim_trailing_whitespace = false | ||
|
|
||
| [*.yml] | ||
| indent_size = 2 | ||
This file contains hidden or 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,57 @@ | ||
| name: Deploy Jekyll with GitHub Pages | ||
|
|
||
| on: | ||
| pull_request: # TEMPORARY !!! | ||
| push: | ||
| branches: ["master"] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v6 | ||
|
|
||
| - name: Install dependencies | ||
| run: | | ||
| docker run --rm \ | ||
| --user $(id -u):$(id -g) \ | ||
| -v "${{ github.workspace }}:/srv/jekyll" \ | ||
| -w /srv/jekyll \ | ||
| -e BUNDLE_PATH=/srv/jekyll/vendor/bundle \ | ||
| jekyll/jekyll:4.2.2 \ | ||
| bundle install | ||
|
|
||
| - name: Build site | ||
| run: | | ||
| docker run --rm \ | ||
| --user $(id -u):$(id -g) \ | ||
| -v "${{ github.workspace }}:/srv/jekyll" \ | ||
| -w /srv/jekyll \ | ||
| -e BUNDLE_PATH=/srv/jekyll/vendor/bundle \ | ||
| jekyll/jekyll:4.2.2 \ | ||
| bundle exec jekyll build -d ./_site | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v4 | ||
|
|
||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -16,4 +16,8 @@ Thumbs.db | |
| .DS_Store | ||
|
|
||
| # po4a .mo files | ||
| *.mo | ||
| *.mo | ||
|
|
||
| # Jekyll | ||
| /.jekyll-cache/ | ||
| /_site/ | ||
Empty file.
This file contains hidden or 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,12 @@ | ||
| source "https://rubygems.org" | ||
|
|
||
| gem "jekyll", "~> 4.2.2" | ||
| gem "minima", "~> 2.5.2" | ||
| gem "webrick", "~> 1.8" | ||
|
|
||
| group :jekyll_plugins do | ||
| gem "jekyll-seo-tag", "~> 2.8.0" | ||
| gem "jekyll-optional-front-matter", "~> 0.3.2" | ||
| gem "jekyll-readme-index", "~> 0.3.0" | ||
| gem "jekyll-relative-links", "~> 0.7.0" | ||
| end |
This file contains hidden or 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,88 @@ | ||
| GEM | ||
| remote: https://rubygems.org/ | ||
| specs: | ||
| addressable (2.8.8) | ||
| public_suffix (>= 2.0.2, < 8.0) | ||
| colorator (1.1.0) | ||
| concurrent-ruby (1.3.6) | ||
| em-websocket (0.5.3) | ||
| eventmachine (>= 0.12.9) | ||
| http_parser.rb (~> 0) | ||
| eventmachine (1.2.7) | ||
| ffi (1.17.2-x86_64-linux-musl) | ||
| forwardable-extended (2.6.0) | ||
| http_parser.rb (0.8.0) | ||
| i18n (1.14.8) | ||
| concurrent-ruby (~> 1.0) | ||
| jekyll (4.2.2) | ||
| addressable (~> 2.4) | ||
| colorator (~> 1.0) | ||
| em-websocket (~> 0.5) | ||
| i18n (~> 1.0) | ||
| jekyll-sass-converter (~> 2.0) | ||
| jekyll-watch (~> 2.0) | ||
| kramdown (~> 2.3) | ||
| kramdown-parser-gfm (~> 1.0) | ||
| liquid (~> 4.0) | ||
| mercenary (~> 0.4.0) | ||
| pathutil (~> 0.9) | ||
| rouge (~> 3.0) | ||
| safe_yaml (~> 1.0) | ||
| terminal-table (~> 2.0) | ||
| jekyll-feed (0.17.0) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-optional-front-matter (0.3.2) | ||
| jekyll (>= 3.0, < 5.0) | ||
| jekyll-readme-index (0.3.0) | ||
| jekyll (>= 3.0, < 5.0) | ||
| jekyll-relative-links (0.7.0) | ||
| jekyll (>= 3.3, < 5.0) | ||
| jekyll-sass-converter (2.2.0) | ||
| sassc (> 2.0.1, < 3.0) | ||
| jekyll-seo-tag (2.8.0) | ||
| jekyll (>= 3.8, < 5.0) | ||
| jekyll-watch (2.2.1) | ||
| listen (~> 3.0) | ||
| kramdown (2.5.1) | ||
| rexml (>= 3.3.9) | ||
| kramdown-parser-gfm (1.1.0) | ||
| kramdown (~> 2.0) | ||
| liquid (4.0.4) | ||
| listen (3.9.0) | ||
| rb-fsevent (~> 0.10, >= 0.10.3) | ||
| rb-inotify (~> 0.9, >= 0.9.10) | ||
| mercenary (0.4.0) | ||
| minima (2.5.2) | ||
| jekyll (>= 3.5, < 5.0) | ||
| jekyll-feed (~> 0.9) | ||
| jekyll-seo-tag (~> 2.1) | ||
| pathutil (0.16.2) | ||
| forwardable-extended (~> 2.6) | ||
| public_suffix (6.0.2) | ||
| rb-fsevent (0.11.2) | ||
| rb-inotify (0.11.1) | ||
| ffi (~> 1.0) | ||
| rexml (3.4.4) | ||
| rouge (3.30.0) | ||
| safe_yaml (1.0.5) | ||
| sassc (2.4.0) | ||
| ffi (~> 1.9) | ||
| terminal-table (2.0.0) | ||
| unicode-display_width (~> 1.1, >= 1.1.1) | ||
| unicode-display_width (1.8.0) | ||
| webrick (1.9.2) | ||
|
|
||
| PLATFORMS | ||
| x86_64-linux-musl | ||
|
|
||
| DEPENDENCIES | ||
| jekyll (~> 4.2.2) | ||
| jekyll-optional-front-matter (~> 0.3.2) | ||
| jekyll-readme-index (~> 0.3.0) | ||
| jekyll-relative-links (~> 0.7.0) | ||
| jekyll-seo-tag (~> 2.8.0) | ||
| minima (~> 2.5.2) | ||
| webrick (~> 1.8) | ||
|
|
||
| BUNDLED WITH | ||
| 2.3.25 |
This file contains hidden or 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,7 @@ | ||
| serve: | ||
| docker run --rm -it \ | ||
| -p 4000:4000 \ | ||
| -v $(PWD):/srv/jekyll \ | ||
| --name yiisoft-docs-dev \ | ||
| jekyll/jekyll:4.2.2 \ | ||
| jekyll serve --host 0.0.0.0 --livereload |
This file contains hidden or 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,10 @@ | ||
| defaults: | ||
| - scope: | ||
| path: "" | ||
| values: | ||
| layout: "default" | ||
| render_with_liquid: false | ||
| baseurl: "/docs" | ||
| theme: minima | ||
| relative_links: | ||
| enabled: true | ||
This file contains hidden or 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,28 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="{{ page.lang | default: site.lang | default: " en" }}"> | ||
|
|
||
| {%- include head.html -%} | ||
|
|
||
| <body> | ||
|
|
||
| {%- include header.html -%} | ||
|
|
||
| <main class="page-content" aria-label="Content"> | ||
| <div class="wrapper"> | ||
| {{ content }} | ||
| </div> | ||
| </main> | ||
|
|
||
| {%- include footer.html -%} | ||
|
|
||
| <script type="module"> | ||
| import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs'; | ||
| mermaid.initialize({startOnLoad: false}); | ||
| mermaid.run({ | ||
| querySelector: 'code.language-mermaid' | ||
| }); | ||
| </script> | ||
|
|
||
| </body> | ||
|
|
||
| </html> |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
render_with_liquid: falseconfiguration has been removed from_config.yml. However, this setting was likely intentional to prevent Jekyll/Liquid from processing Markdown files that contain Twig syntax (which uses similar{{ }}and{% %}delimiters). Removing this setting means Jekyll will now try to process all Liquid-like syntax in the documentation.While the PR adds
{% raw %}tags to one specific code block intemplate-engines.md, there are multiple other Twig code blocks in the same file (lines 19-43, 49-55, 75-87, 90-99) that also contain Liquid-like syntax but are NOT wrapped in{% raw %}tags. These will now be processed by Jekyll and potentially cause build errors or incorrect rendering.Either the
render_with_liquid: falsesetting should be kept, or ALL Twig code blocks throughout the documentation need to be wrapped with{% raw %}/{% endraw %}tags.