forked from google/docsy
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from bdfinst/sync-to-upstream
Sync to upstream
- Loading branch information
Showing
122 changed files
with
2,782 additions
and
1,263 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
* text=auto eol=lf | ||
*.cmd text eol=crlf | ||
*.bat text eol=crlf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Bug report | ||
labels: [bug, needs-triage] | ||
about: Create a report to help us improve | ||
--- | ||
|
||
<!-- Describe you environment by answering the questions below. Put your answers after the colon on each line. --> | ||
|
||
### Environment | ||
|
||
- [ ] Version of Docsy you are using: | ||
- [ ] How are you using Docsy? As a: | ||
- [ ] Hugo module | ||
- [ ] NPM module | ||
- [ ] Git submodule | ||
- [ ] Other: | ||
- [ ] Version of Hugo you are using (output of `hugo version`): | ||
- [ ] OS: | ||
- [ ] Linux | ||
- [ ] macOS | ||
- [ ] Windows | ||
- [ ] Other: | ||
|
||
### Problem | ||
|
||
<!-- Concisely describe the problem you are seeing, ideally provide steps to reproduce it. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: SUPPORT, ISSUES, and TROUBLESHOOTING | ||
url: https://github.com/google/docsy/discussions | ||
about: | ||
Please DO NOT use GitHub issues for support requests, instead start a | ||
discussion thread at https://github.com/google/docsy/discussions. Feel | ||
free to open an issue once your problem is confirmed by the docsy | ||
maintainers and/or the docsy community. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
name: Enhancement proposal | ||
labels: [enhancement, needs-triage] | ||
about: Propose an enhancement or submit a feature request | ||
--- | ||
|
||
<!-- Tell us about the enhancement or describe your feature wish. Think about if it really belongs in the docsy theme; you may want to discuss it on https://github.com/google/docsy/discussions first. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Smoke test across OSs: build a Docsy-based site from scratch, | ||
# using Docsy as hugo module and fetching Docsy via NPM. | ||
|
||
name: smoke | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
pull_request: | ||
# schedule: # midnight every day | ||
# - cron: '0 0 * * *' | ||
workflow_dispatch: | ||
|
||
jobs: | ||
new-site: | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
os: [windows-latest, ubuntu-latest] | ||
docsy-src: [NPM, HUGO_MODULE] | ||
env: | ||
BASE_REPO: ${{ github.repository }} | ||
BRANCH: ${{ github.head_ref }} | ||
PR_REPO: ${{ github.event.pull_request.head.repo.full_name }} | ||
SHA: ${{ github.sha }} | ||
# TODO: drop PR testing under Windows because it's too slow? | ||
# if: github.event_name != 'pull_request' && matrix.os != 'windows-latest' | ||
if: github.event_name != 'push' || github.repository == 'google/docsy' | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version-file: .nvmrc | ||
cache: npm | ||
cache-dependency-path: package.json | ||
- run: tools/install-hugo.sh | ||
shell: bash | ||
- name: Make site (non-PR) | ||
if: github.event_name != 'pull_request' | ||
run: | | ||
mkdir tmp && cd tmp && set -x | ||
../tools/make-site.sh -s ${{ matrix.docsy-src }} -r $BASE_REPO -v $SHA | ||
shell: bash | ||
- name: Make site from PR | ||
if: github.event_name == 'pull_request' | ||
run: | | ||
mkdir tmp && cd tmp && set -x | ||
../tools/make-site.sh -s ${{ matrix.docsy-src }} -r $PR_REPO -v $BRANCH | ||
shell: bash |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Build Docsy & the User Guide and run all repo checks across OSs. | ||
|
||
name: test | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
pull_request: | ||
# schedule: | ||
# - cron: '11 0 * * *' # 11 past midnight every day | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build: | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
os: [windows-latest, ubuntu-latest] | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version-file: .nvmrc | ||
cache: npm | ||
cache-dependency-path: package.json | ||
- run: npm install --omit=optional | ||
- run: npm run test:all |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
node_modules/ | ||
package-lock.json | ||
/tmp | ||
|
||
# Hugo | ||
.hugo_build.lock | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
{ | ||
"ignorePatterns": [ | ||
{ | ||
"pattern": "^http://localhost" | ||
}, | ||
{ | ||
"pattern": "^https://badges.netlify.com/api/docsydocs.svg\\?branch=main" | ||
}, | ||
{ | ||
"pattern": "https://docs.npmjs.com/cli/v10/using-npm/scripts#prepare-and-prepublish" | ||
} | ||
], | ||
"timeout": "3s", | ||
"retryOn429": true, | ||
"aliveStatusCodes": [200, 206] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.nvmrc | ||
.prettierignore | ||
.s3deploy.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"semi": true, | ||
"singleQuote": true, | ||
"tabWidth": 4 | ||
"proseWrap": "always", | ||
"semi": true, | ||
"singleQuote": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,6 @@ | ||
// For settings, see https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/ | ||
{ | ||
"version": "0.2", | ||
"caseSensitive": true, | ||
"words": [ | ||
"Docsy", | ||
"shortcode", | ||
"shortcodes" | ||
] | ||
"version": "0.2", | ||
"caseSensitive": true, | ||
"words": ["Docsy", "hugo", "shortcode", "shortcodes", "warnf"] | ||
} |
Oops, something went wrong.