Skip to content

Commit f076e30

Browse files
authored
Merge branch 'main' into main
2 parents 34a3f3a + 69d4d6c commit f076e30

179 files changed

Lines changed: 7897 additions & 3199 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.

.github/workflows/smoke.yaml

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Smoke test across OSs: build a Docsy-based site from scratch,
22
# using Docsy as hugo module and fetching Docsy via NPM.
3+
# cSpell:ignore docsy github
34

45
name: smoke
56

@@ -29,22 +30,35 @@ jobs:
2930
if: github.event_name != 'push' || github.repository == 'google/docsy'
3031
steps:
3132
- uses: actions/checkout@v4
33+
3234
- uses: actions/setup-node@v4
3335
with:
3436
node-version-file: .nvmrc
3537
cache: npm
3638
cache-dependency-path: package.json
37-
- run: tools/install-hugo.sh
39+
40+
- name: Setup workspace
41+
run: |
42+
npm install
43+
mkdir -p tmp && cd tmp && npm init -y
3844
shell: bash
45+
3946
- name: Make site (non-PR)
4047
if: github.event_name != 'pull_request'
41-
run: |
42-
mkdir tmp && cd tmp && set -x
43-
../tools/make-site.sh -s ${{ matrix.docsy-src }} -r $BASE_REPO -v $SHA
48+
working-directory: tmp
49+
run: ../scripts/make-site.sh -s ${{ matrix.docsy-src }} -r $BASE_REPO -v $SHA
4450
shell: bash
51+
4552
- name: Make site from PR
4653
if: github.event_name == 'pull_request'
47-
run: |
48-
mkdir tmp && cd tmp && set -x
49-
../tools/make-site.sh -s ${{ matrix.docsy-src }} -r $PR_REPO -v $BRANCH
54+
working-directory: tmp
55+
run: ../scripts/make-site.sh -s ${{ matrix.docsy-src }} -r $PR_REPO -v $BRANCH
5056
shell: bash
57+
58+
- uses: actions/upload-artifact@v4
59+
with:
60+
name: tmp-site-${{ matrix.os }}-${{ matrix.docsy-src }}
61+
path: |
62+
tmp
63+
!**/node_modules
64+
!**/resources

.github/workflows/test.yaml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Build Docsy & the User Guide and run all repo checks across OSs.
1+
# Build Docsy & the website and run all repo checks across OSs.
2+
# cSpell:ignore docsy
23

34
name: test
45

@@ -19,13 +20,23 @@ jobs:
1920
os: [windows-latest, ubuntu-latest]
2021
steps:
2122
- uses: actions/checkout@v4
23+
2224
- uses: actions/setup-node@v4
2325
with:
2426
node-version-file: .nvmrc
2527
cache: npm
2628
cache-dependency-path: package.json
29+
2730
- run: npm install --omit=optional
31+
2832
- if: runner.os != 'Windows'
29-
run: npm run test:all
33+
run: npm run ci:test
34+
3035
- if: runner.os == 'Windows'
31-
run: npm run ci:prepare && npm run cd:docs build && npm run ci:post
36+
run: npm run ci:prepare && npm run cd:docsy.dev build && npm run ci:post
37+
38+
- uses: actions/upload-artifact@v4
39+
with:
40+
name: test-site-${{ matrix.os }}
41+
path: |
42+
docsy.dev/public

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ node_modules/
22
package-lock.json
33
/tmp
44

5+
# ScrollSpy patch related
6+
# Temporary files created by the patch command when it fails:
7+
assets/_cache/bootstrap/scrollspy-method.js.*
8+
59
# Hugo
610
.hugo_build.lock
711
/public

.markdownlint-cli2.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# cSpell:ignore docsy github lookandfeel iconsimages
2+
3+
globs:
4+
- '!node_modules/**'
5+
- '!public/**'
6+
- '!tmp/**'
7+
- '!docsy.dev/**'
8+
- docsy.dev/content/en/docs/content/iconsimages.md
9+
- docsy.dev/content/en/docs/content/language.md
10+
- docsy.dev/content/en/docs/content/lookandfeel.md
11+
- docsy.dev/content/en/docs/content/navigation.md
12+
# - docsy.dev/content/en/docs/content/repository-links.md
13+
# - docsy.dev/content/en/docs/content/search.md
14+
# - docsy.dev/content/en/docs/content/shortcodes.md
15+
# - docsy.dev/content/en/docs/content/versioning.md
16+
- docsy.dev/content/en/blog/2025/0.13.0.md
17+
config:
18+
extends: .markdownlint.yaml

.markdownlint.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# See https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases
2+
# cSpell:ignore docsy
3+
4+
default: true
5+
6+
blanks-around-fences: false
7+
emphasis-style: false
8+
first-line-h1: false
9+
line-length: false
10+
link-fragments: false
11+
list-marker-space: false
12+
no-emphasis-as-header: false
13+
no-hard-tabs: false
14+
no-inline-html: false
15+
no-trailing-punctuation: false
16+
no-trailing-spaces: { br_spaces: 0, strict: true}
17+
# table-column-style: false

.prettierignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Note that Prettier ignore rules differ slightly from gitignore rules. The main
2+
# gotcha is that once a _directory_ is ignored, it's content cannot be
3+
# unignored.
4+
5+
# Ignore all _files_ under assets
6+
/assets/**/*.*
7+
8+
# Selectively unignore some files
9+
!/assets/scss/main.scss
10+
!/assets/scss/td/**/*
11+
12+
/assets/scss/td/chroma/**/*

.vscode/cspell.json

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,29 @@
33
"version": "0.2",
44
"caseSensitive": true,
55
"words": [
6+
"anchorize",
67
"Docsy",
78
"errorf",
9+
"Gantt",
10+
"GLFM",
11+
"htmltest",
812
"hugo",
13+
"isset",
14+
"markdownify",
15+
"nvmrc",
16+
"Occitan",
17+
"refcache",
918
"relref",
1019
"scrollspy",
1120
"shortcode",
1221
"shortcodes",
22+
"subfolders",
1323
"tabpane",
24+
"unmarshal",
1425
"upvote",
15-
"warnf"
26+
"viewports",
27+
"warnf",
28+
"warnidf",
29+
"wrapup"
1630
]
1731
}

0 commit comments

Comments
 (0)