mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-15 23:52:23 -06:00
2ccc451c2a
* Remove "passive" toggle PR #1244 introduced the "passive" toggle, but just-the-docs.js subsequently disabled the only styling that used it, so it became redundant. This removes it. * Reduce build time for page-dependent CSS Fix #1323 - Remove `_includes/head_nav.html`. - Generate page-independent SCSS in `assets/css/just-the-docs-head-nav.css`. - Link to `/assets/css/just-the-docs-head-nav.css` in `head.html`. - Disable the above stylesheet in `assets/js/just-the-docs.js`. - Generate page-dependent CSS in `_includes/css/activation.scss.liquid` and include in `head.html`. * No override svg rotate * Disable both stylesheets safely * Move the site nav to a new include - Fix the complete site nav - Move the site nav to `_includes/site_nav.html` - Cache the site nav - Uncache `nav.html` * Move nav and site_nav to _includes/components * Replace id prefix * Update breadcrumbs.html Replace several filters by a single loop through all the pages, but breaking as soon as possible. Profiling indicates that this saves up to 50% of the breadcrumbs build time for the filters. * Update just-the-docs-head-nav.css Adjust the number of lines to keep * Update head.html Remove superflous type. * Update activation.scss.liquid Remove a superfluous closing brace. Adjust layout. * Use `scssify` to remove nesting Preliminary profiling indicates that using `scssify` on the small number of nested CSS rules produced by `activation.scss.liquid` is quick enough. * Update head.scss Manual attempt at prettier (pending installation in Atom). * Avoid generation of nested CSS Local profiling indicated that using `scssify` on each page takes about 1% of the build time. - Update `_includes/css/activation.scss.liquid` to generate non-nested CSS. - Remove use of `scssify` from `_includes/head.html`. * Ignore false positives from validator Ignores: `:1.810-1.823: error: CSS: Parse Error.` and `:1.811-1.824: error: CSS: Parse Error.`; had to shift things around since the local config overrides the CI flag. * Inline `_sass/head.css` * Update CHANGELOG.md --------- Co-authored-by: Matthew Wang <matt@matthewwang.me>
109 lines
3.0 KiB
YAML
109 lines
3.0 KiB
YAML
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
|
|
name: CI
|
|
|
|
jobs:
|
|
jekyll-build:
|
|
name: Build (jekyll gem)
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
jekyll-version: [3.9, 4.3]
|
|
os: [ ubuntu-latest, macos-latest, windows-latest ]
|
|
ruby-version: ["3.0", "3.1", "3.2"]
|
|
runs-on: ${{ matrix.os }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Setup Ruby ${{ matrix.ruby-version }}
|
|
uses: ruby/setup-ruby@v1
|
|
with:
|
|
ruby-version: ${{ matrix.ruby-version }}
|
|
bundler-cache: false
|
|
- name: Bundle Install (Jekyll ${{ matrix.jekyll-version }})
|
|
run: bundle install
|
|
env:
|
|
BUNDLE_GEMFILE: fixtures/Gemfile-jekyll-${{ matrix.jekyll-version }}
|
|
- name: Init Search
|
|
run: bundle exec rake search:init
|
|
env:
|
|
BUNDLE_GEMFILE: fixtures/Gemfile-jekyll-${{ matrix.jekyll-version }}
|
|
- name: Build Site
|
|
run: bundle exec jekyll build
|
|
env:
|
|
BUNDLE_GEMFILE: fixtures/Gemfile-jekyll-${{ matrix.jekyll-version }}
|
|
|
|
github-pages-build:
|
|
name: Build (github-pages gem)
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Setup Ruby
|
|
uses: ruby/setup-ruby@v1
|
|
with:
|
|
ruby-version: "3.2"
|
|
bundler-cache: false
|
|
- name: Bundle Install
|
|
run: bundle install
|
|
env:
|
|
BUNDLE_GEMFILE: fixtures/Gemfile-github-pages
|
|
- name: Build Site
|
|
run: bundle exec jekyll build
|
|
env:
|
|
BUNDLE_GEMFILE: fixtures/Gemfile-github-pages
|
|
|
|
validate:
|
|
name: Validate HTML
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
ruby-version: ["3.2"]
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Setup Ruby ${{ matrix.ruby-version }}
|
|
uses: ruby/setup-ruby@v1
|
|
with:
|
|
ruby-version: ${{ matrix.ruby-version }}
|
|
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
|
|
cache-version: 0 # Increment this number if you need to re-download cached gems
|
|
- name: Cache HTMLProofer
|
|
id: cache-htmlproofer
|
|
uses: actions/cache@v3
|
|
with:
|
|
path: tmp/.htmlproofer
|
|
key: ${{ runner.os }}-htmlproofer
|
|
- name: Build Site
|
|
run: bundle exec jekyll build
|
|
- name: Test with Nu Validator
|
|
uses: Cyb3r-Jak3/html5validator-action@2a593a9f2c10593cbac84791a6fc4c47e9a106c8
|
|
with:
|
|
config: fixtures/html5validator-config.yml
|
|
- name: Test with html-proofer
|
|
run: bundle exec htmlproofer _site --ignore-urls "/github.com/,/web.archive.org/"
|
|
env:
|
|
NOKOGIRI_USE_SYSTEM_LIBRARIES: true
|
|
|
|
assets:
|
|
name: Test CSS and JS
|
|
runs-on: ubuntu-latest
|
|
|
|
strategy:
|
|
matrix:
|
|
node-version: [18.x]
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Use Node.js ${{ matrix.node-version }}
|
|
uses: actions/setup-node@v3
|
|
with:
|
|
node-version: ${{ matrix.node-version }}
|
|
- run: npm install
|
|
- run: npm test
|