Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
5c59c94
build: add workflow for github pages
diatrcz Jul 3, 2026
e551545
build: add github pages config
diatrcz Jul 3, 2026
b6cb85f
fix: correct GitHub Pages rendering issues
diatrcz Jul 15, 2026
eaf27b9
chore: modify workflow file for testing
diatrcz Jul 16, 2026
7fdbbd9
chore: modify workflow file for testing
diatrcz Jul 16, 2026
0cdc8ed
chore: modify workflow file for testing
diatrcz Jul 16, 2026
528f2b6
chore: modify workflow file for testing
diatrcz Jul 16, 2026
b4593bf
chore: modify workflow file for testing
diatrcz Jul 16, 2026
cf58dfd
chore: fix rendering issues in md files
diatrcz Jul 16, 2026
8cfd8bc
chore: fix rendering issues in md files
diatrcz Jul 16, 2026
670833e
docs: fix html formatting in markdown files
diatrcz Jul 20, 2026
589feaa
docs: fix html formatting in markdown files
diatrcz Jul 20, 2026
30b19c0
docs: fix html formatting in markdown files
diatrcz Jul 21, 2026
631898c
docs: fix html formatting in markdown files
diatrcz Jul 21, 2026
e7c2f35
docs: fix html formatting in markdown files
diatrcz Jul 21, 2026
9fc5fa5
docs: fix html formatting in markdown files
diatrcz Jul 21, 2026
ece2553
docs: fix html formatting in markdown files
diatrcz Jul 21, 2026
2945800
docs: fix html formatting in markdown files
diatrcz Jul 21, 2026
96132a6
docs: fix html formatting in markdown files
diatrcz Jul 21, 2026
bbeb12a
build: revert workflow file to main
diatrcz Jul 21, 2026
1d64b72
Merge branch 'main' into lt/github-pages
diatrcz Jul 23, 2026
d18a3c9
chore: add requested changes
diatrcz Jul 23, 2026
55c35c9
Merge branch 'lt/github-pages' of https://github.com/IBM/openapi-vali…
diatrcz Jul 23, 2026
f24a926
chore: add requested changes
diatrcz Jul 23, 2026
99bd83f
build: revert branch back to main on github pages
diatrcz Jul 23, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: deploy github pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./
destination: ./_site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

# Deployment job
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@v5
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -986,7 +986,7 @@ Here is an example of JSON output:
"entries": []
}
},
"hasResults": true
"hasResults": true,
"impactScore": {
"categorizedSummary": {
"usability": 94,
Expand Down
16 changes: 16 additions & 0 deletions _config.yml

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this file should be in the project root as that's the source directory for Jekyll in the GH Action workflow.

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
title: IBM OpenAPI Validator
description: A highly configurable linter/validator for OpenAPI documents.
theme: minima

exclude:
- README.md
- CHANGELOG.md
- CONTRIBUTING.md
- Migration-Guide.md
- docs/automated-quality-screening.md
- docs/openapi-ruleset-utilities.md
- packages/
- node_modules/
- scripts/
- coverage/
- test-local/
27 changes: 27 additions & 0 deletions _sass/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Fix table layout so they never cause horizontal page scroll.
// Tables are constrained to the wrapper width; pre blocks inside
// cells scroll only within the cell (vertically wrapping the content).

.post-content {
table {
table-layout: fixed;
width: 100%;
word-wrap: break-word;
overflow-wrap: break-word;

td, th {
word-wrap: break-word;
overflow-wrap: break-word;
}

// pre / code blocks inside table cells: scroll horizontally within
// the cell only, never overflow the page.
td pre, th pre {
overflow-x: auto;
max-width: 100%;
white-space: pre;
word-wrap: normal;
overflow-wrap: normal;
}
}
}
6 changes: 6 additions & 0 deletions assets/main.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
# Only the main Sass file needs front matter (the dashes are enough)
---

@import "minima";
@import "custom";
Loading
Loading