Skip to content

Commit 99fa4f9

Browse files
kavaivalerikavaivaleri
committed
Merge remote-tracking branch 'other-repo/main'
2 parents ff48353 + 45b6033 commit 99fa4f9

173 files changed

Lines changed: 17688 additions & 0 deletions

File tree

Some content is hidden

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

‎.devcontainer/Dockerfile‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# [Choice] Debian OS version (use bullseye on local arm64/Apple Silicon): bullseye, buster
2+
ARG VARIANT=bullseye
3+
FROM mcr.microsoft.com/vscode/devcontainers/jekyll:0-${VARIANT}
4+
5+
# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
6+
ARG NODE_VERSION="none"
7+
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
8+
9+
# [Optional] Uncomment this section to install additional OS packages.
10+
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
11+
# && apt-get -y install --no-install-recommends <your-package-list-here>
12+
13+
# [Optional] Uncomment this line to install global node packages.
14+
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

‎.devcontainer/base.Dockerfile‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# [Choice] Debian OS version (use 2.7-bullseye on local arm64/Apple Silicon): 2.7-bullseye, 2.7-buster
2+
ARG VARIANT=2.7-bullseye
3+
FROM mcr.microsoft.com/vscode/devcontainers/ruby:${VARIANT}
4+
COPY library-scripts/meta.env /usr/local/etc/vscode-dev-containers
5+
6+
# ENV Variables required by Jekyll
7+
ENV LANG=en_US.UTF-8 \
8+
LANGUAGE=en_US:en \
9+
TZ=Etc/UTC \
10+
LC_ALL=en_US.UTF-8 \
11+
LANG=en_US.UTF-8 \
12+
LANGUAGE=en_US
13+
14+
# Install bundler, latest jekyll, and github-pages for older jekyll
15+
RUN gem install bundler jekyll github-pages
16+
17+
# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
18+
ARG NODE_VERSION="none"
19+
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
20+
21+
# [Optional] Uncomment this section to install additional OS packages.
22+
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
23+
# && apt-get -y install --no-install-recommends <your-package-list-here>
24+
25+
# [Optional] Uncomment this line to install global node packages.
26+
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

‎.devcontainer/devcontainer.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
2+
// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.2/containers/jekyll
3+
{
4+
"name": "Just the docs",
5+
"build": {
6+
"dockerfile": "Dockerfile",
7+
"args": {
8+
// Update 'VARIANT' to pick a Debian OS version: bullseye, buster
9+
// Use bullseye when on local arm64/Apple Silicon.
10+
"VARIANT": "bullseye",
11+
// Enable Node.js: pick the latest LTS version
12+
"NODE_VERSION": "lts/*"
13+
}
14+
},
15+
16+
// Set *default* container specific settings.json values on container create.
17+
"settings": {},
18+
19+
// Add the IDs of extensions you want installed when the container is created.
20+
"extensions": ["GitHub.vscode-pull-request-github"],
21+
22+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
23+
"forwardPorts": [
24+
// Jekyll server
25+
4000,
26+
// Live reload server
27+
35729
28+
],
29+
30+
// Use 'postCreateCommand' to run commands after the container is created.
31+
"postCreateCommand": "sh .devcontainer/post-create.sh",
32+
33+
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
34+
"remoteUser": "vscode"
35+
}

‎.devcontainer/post-create.sh‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#!/bin/sh
2+
3+
# Install the version of Bundler.
4+
if [ -f Gemfile.lock ] && grep "BUNDLED WITH" Gemfile.lock > /dev/null; then
5+
cat Gemfile.lock | tail -n 2 | grep -C2 "BUNDLED WITH" | tail -n 1 | xargs gem install bundler -v
6+
fi
7+
8+
# If there's a Gemfile, then run `bundle install`
9+
# It's assumed that the Gemfile will install Jekyll too
10+
if [ -f Gemfile ]; then
11+
bundle install
12+
fi

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: just-the-docs
2+
open_collective: just-the-docs

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/just-the-docs/just-the-docs/discussions
5+
about: Ask questions and discuss with other community members

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/dependabot.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
time: "10:00"
8+
open-pull-requests-limit: 10
9+
- package-ecosystem: bundler
10+
directory: "/"
11+
schedule:
12+
interval: daily
13+
time: "10:00"
14+
open-pull-requests-limit: 10
15+
- package-ecosystem: "github-actions"
16+
directory: "/"
17+
schedule:
18+
interval: daily
19+
time: "10:00"
20+
open-pull-requests-limit: 10

‎.github/workflows/ci.yml‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
pull_request:
6+
branches:
7+
- main
8+
9+
name: CI
10+
11+
jobs:
12+
jekyll-build:
13+
name: Build (jekyll gem)
14+
strategy:
15+
fail-fast: false
16+
matrix:
17+
jekyll-version: [3.9, 4.3]
18+
os: [ubuntu-latest, macos-latest, windows-latest]
19+
ruby-version: ["3.1", "3.2", "3.3", "3.4"]
20+
runs-on: ${{ matrix.os }}
21+
steps:
22+
- uses: actions/checkout@v4
23+
- name: Setup Ruby ${{ matrix.ruby-version }}
24+
uses: ruby/setup-ruby@v1
25+
with:
26+
ruby-version: ${{ matrix.ruby-version }}
27+
bundler-cache: false
28+
- name: Bundle Install (Jekyll ${{ matrix.jekyll-version }})
29+
run: bundle install
30+
env:
31+
BUNDLE_GEMFILE: fixtures/Gemfile-jekyll-${{ matrix.jekyll-version }}
32+
- name: Init Search
33+
run: bundle exec rake search:init
34+
env:
35+
BUNDLE_GEMFILE: fixtures/Gemfile-jekyll-${{ matrix.jekyll-version }}
36+
- name: Build Site
37+
run: bundle exec jekyll build
38+
env:
39+
BUNDLE_GEMFILE: fixtures/Gemfile-jekyll-${{ matrix.jekyll-version }}
40+
41+
github-pages-build:
42+
name: Build (github-pages gem)
43+
runs-on: ubuntu-latest
44+
steps:
45+
- uses: actions/checkout@v4
46+
- name: Setup Ruby
47+
uses: ruby/setup-ruby@v1
48+
with:
49+
ruby-version: "3.4"
50+
bundler-cache: false
51+
- name: Bundle Install
52+
run: bundle install
53+
env:
54+
BUNDLE_GEMFILE: fixtures/Gemfile-github-pages
55+
- name: Build Site
56+
run: bundle exec jekyll build
57+
env:
58+
BUNDLE_GEMFILE: fixtures/Gemfile-github-pages
59+
60+
validate:
61+
name: Validate HTML
62+
strategy:
63+
fail-fast: false
64+
matrix:
65+
ruby-version: ["3.4"]
66+
runs-on: ubuntu-latest
67+
68+
steps:
69+
- uses: actions/checkout@v4
70+
- name: Setup Ruby ${{ matrix.ruby-version }}
71+
uses: ruby/setup-ruby@v1
72+
with:
73+
ruby-version: ${{ matrix.ruby-version }}
74+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
75+
cache-version: 0 # Increment this number if you need to re-download cached gems
76+
- name: Cache HTMLProofer
77+
id: cache-htmlproofer
78+
uses: actions/cache@v4
79+
with:
80+
path: tmp/.htmlproofer
81+
key: ${{ runner.os }}-htmlproofer
82+
- name: Build Site
83+
run: bundle exec jekyll build
84+
- name: Test with Nu Validator
85+
uses: Cyb3r-Jak3/html5validator-action@8c6ac0aa42df299c0322ce9980fed61c10930a66
86+
with:
87+
config: fixtures/html5validator-config.yml
88+
- name: Test with html-proofer
89+
run: bundle exec htmlproofer _site --ignore-urls "/github.com/,/web.archive.org/,/flickr.com/"
90+
env:
91+
NOKOGIRI_USE_SYSTEM_LIBRARIES: true
92+
93+
assets:
94+
name: Test CSS and JS
95+
runs-on: ubuntu-latest
96+
97+
strategy:
98+
matrix:
99+
node-version: [22.x]
100+
101+
steps:
102+
- uses: actions/checkout@v4
103+
- name: Use Node.js ${{ matrix.node-version }}
104+
uses: actions/setup-node@v4
105+
with:
106+
node-version: ${{ matrix.node-version }}
107+
- run: npm install
108+
- run: npm test

0 commit comments

Comments
 (0)