Skip to content

Commit 2d7712f

Browse files
committed
Updating build and style with latest OSG setup
1 parent b0833ae commit 2d7712f

File tree

4 files changed

+56
-10
lines changed

4 files changed

+56
-10
lines changed
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
name: Deploy static MkDocs pages
22
on:
33
push:
4-
branches: [ master ]
4+
branches:
5+
- master
56

67
jobs:
78
deploy-mkdocs:
89
runs-on: ubuntu-latest
910
steps:
10-
- uses: actions/checkout@v2
11+
- uses: actions/checkout@v3
1112
with:
1213
fetch-depth: 0
1314
- name: Deploy MkDocs pages
@@ -16,4 +17,4 @@ jobs:
1617
with:
1718
args: >-
1819
gh-deploy
19-
--verbose
20+
--verbose
Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
name: Valdate static MkDocs pages
1+
name: Validate static MkDocs pages
22
on: pull_request
33

44
jobs:
55
validate-mkdocs:
66
runs-on: ubuntu-latest
77
steps:
8-
- uses: actions/checkout@v2
8+
- uses: actions/checkout@v3
99
- name: Build MkDocs pages
10-
uses: docker://squidfunk/mkdocs-material:7.1.0
10+
uses: docker://squidfunk/mkdocs-material:8.2.8
1111
timeout-minutes: 1
1212
with:
1313
args: >-
@@ -16,16 +16,18 @@ jobs:
1616
--strict
1717
1818
- id: format-github-repo
19-
run: echo "::set-output name=repo-name::${GITHUB_REPOSITORY#*\/}"
19+
run: echo "repo-name=${GITHUB_REPOSITORY#*\/}" >> $GITHUB_OUTPUT
2020

2121
- name: Test links
2222
timeout-minutes: 10
2323
uses: docker://klakegg/html-proofer:3.16.0
24+
env:
25+
GITHUB_REPOSITORY: ${{ github.repository }}
2426
with:
2527
args: >-
2628
--allow-hash-href
2729
--check-html
28-
--http-status-ignore 302,401
30+
--http-status-ignore 302
2931
--file-ignore ./site/404.html
30-
--url-ignore "https://psetf.opensciencegrid.org/etf/check_mk/index.py?start_url=%2Fetf%2Fcheck_mk%2Fdashboard.py/,/https://github.com/osg-htc/networking/edit/master/docs/perfsonar/psetf.md/,/http://etf.cern.ch/docs/latest/,/https://github.com/osg-htc/networking/edit/master/docs/perfsonar/installation.md/,/https://psetf.opensciencegrid.org/etf/check_mk/,https://fonts.gstatic.com,/github.com\/opensciencegrid\/${{ steps.format-github-repo.outputs.repo-name }}\/edit/,/opensciencegrid.org\/${{ steps.format-github-repo.outputs.repo-name }}/"
31-
./site
32+
--url-ignore "https://fonts.gstatic.com,/hypernews.cern.ch/,/github.com\/osg-htc\/${{ steps.format-github-repo.outputs.repo-name }}\/edit/,/osg-htc.org\/${{ steps.format-github-repo.outputs.repo-name }}/,/\/${{ steps.format-github-repo.outputs.repo-name }}/"
33+
./site

docs/css/extra.css

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
12
.codehilite{
23
width:100%;
34
height: auto;
45
overflow: auto;
6+
margin-bottom: 24px;
57
}
68

79
.codehilite .hll { background-color: #ffffcc }
@@ -75,3 +77,28 @@ code, tt {
7577
font-size: 100%;
7678
}
7779

80+
.wy-side-nav-search {
81+
background-color: #343a40;
82+
}
83+
.wy-nav-top {
84+
background-color: #343a40;
85+
}
86+
.md-header {
87+
background-color: #343a40;
88+
}
89+
.md-tabs {
90+
background-color: #1f2326;
91+
}
92+
.md-tabs .md-tabs--active {
93+
background-color: #1f2326;
94+
}
95+
@media only screen and (max-width: 76.1875em) {
96+
html .md-nav--primary .md-nav__title--site {
97+
background-color: #343a40;
98+
}
99+
}
100+
101+
/* Repository background color for mobile */
102+
.md-nav__source {
103+
background-color: #1f2326;
104+
}

mkdocs.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
site_name: OSG Networking Area
22
site_url: https://osg-htc.org/networking/
33
repo_url: https://github.com/osg-htc/networking/
4+
extra:
5+
analytics:
6+
provider: google
7+
property: UA-69012-29
48
theme:
59
name: material
610
custom_dir: osgthedocs
@@ -26,4 +30,16 @@ nav:
2630
markdown_extensions:
2731
- admonition
2832
- codehilite
33+
guess_lang: False
34+
- meta
35+
- toc:
36+
permalink: True
37+
- pymdownx.superfences:
38+
custom_fences:
39+
- name: mermaid
40+
class: mermaid
41+
format: !!python/name:pymdownx.superfences.fence_code_format
42+
- attr_list
2943

44+
plugins:
45+
- search

0 commit comments

Comments
 (0)