Skip to content

Commit d11b913

Browse files
askuricaskuric
committed
FEAT init copy
0 parents  commit d11b913

File tree

265 files changed

+16193
-0
lines changed

Some content is hidden

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

265 files changed

+16193
-0
lines changed

‎.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/pmarsceill/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/workflows/ci-master.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
on:
2+
push:
3+
branches:
4+
- master
5+
6+
name: Master branch CI
7+
8+
jobs:
9+
10+
jekyll-latest:
11+
name: Build Jekyll site (latest)
12+
runs-on: ubuntu-latest
13+
steps:
14+
15+
- uses: actions/checkout@master
16+
17+
- name: Build the site in the jekyll/builder container
18+
run: |
19+
docker run --rm \
20+
--volume="${{ github.workspace }}:/srv/jekyll" \
21+
jekyll/builder:latest /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && jekyll build && bundle exec just-the-docs rake search:init"
22+
jekyll-3-8-5:
23+
name: Build Jekyll site (v3.8.5)
24+
runs-on: ubuntu-latest
25+
steps:
26+
27+
- uses: actions/checkout@master
28+
29+
- name: Build the site in the jekyll/builder container
30+
run: |
31+
docker run --rm \
32+
--volume="${{ github.workspace }}:/srv/jekyll" \
33+
jekyll/builder:3.8.5 /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && jekyll build && bundle exec just-the-docs rake search:init"
34+
assets:
35+
name: Format and test CSS and JS
36+
runs-on: ubuntu-latest
37+
38+
steps:
39+
- uses: actions/checkout@v2
40+
- name: Use Node.js 12.x
41+
uses: actions/setup-node@v1
42+
with:
43+
node-version: '12.x'
44+
- run: npm install
45+
- run: npm test

‎.github/workflows/ci.yml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
on: [pull_request]
2+
3+
name: CI
4+
5+
jobs:
6+
7+
jekyll-latest:
8+
name: Build Jekyll site (latest)
9+
runs-on: ubuntu-latest
10+
steps:
11+
12+
- uses: actions/checkout@master
13+
14+
- name: Build the site in the jekyll/builder container
15+
run: |
16+
docker run --rm \
17+
--volume="${{ github.workspace }}:/srv/jekyll" \
18+
jekyll/builder:latest /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && jekyll build && bundle exec just-the-docs rake search:init"
19+
20+
jekyll-3-8-5:
21+
name: Build Jekyll site (v3.8.5)
22+
runs-on: ubuntu-latest
23+
steps:
24+
25+
- uses: actions/checkout@master
26+
27+
- name: Build the site in the jekyll/builder container
28+
run: |
29+
docker run --rm \
30+
--volume="${{ github.workspace }}:/srv/jekyll" \
31+
jekyll/builder:3.8.5 /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && jekyll build && bundle exec just-the-docs rake search:init"
32+
33+
assets:
34+
name: Format and test CSS and JS
35+
runs-on: ubuntu-latest
36+
37+
steps:
38+
- uses: actions/checkout@v2
39+
# Using this so the this instead of GITHUB_TOKEN so that this workflow can trigger another
40+
with:
41+
token: ${{ secrets.PAT }}
42+
- name: Use Node.js 12.x
43+
uses: actions/setup-node@v1
44+
with:
45+
node-version: '12.x'
46+
- name: Extract branch name
47+
shell: bash
48+
run: echo "##[set-output name=branch;]$(echo ${GITHUB_HEAD_REF#refs/heads/})"
49+
id: extract_branch
50+
51+
- run: npm install
52+
- run: npm run format
53+
- name: Add changed files
54+
run: |
55+
echo "https://$GITHUB_ACTOR:[email protected]/$GITHUB_REPOSITORY.git"
56+
git config --global user.email [email protected]
57+
git config --global user.name $GITHUB_ACTOR
58+
echo "extracted branch is ${{ steps.extract_branch.outputs.branch }}"
59+
git checkout -b ${{ steps.extract_branch.outputs.branch }}
60+
git status
61+
git add .
62+
- name: Are there any updates?
63+
shell: bash
64+
run: echo "##[set-output name=status]$(git status -s)"
65+
id: is_dirty
66+
- name: Commit files
67+
if: steps.is_dirty.outputs.status
68+
run: |
69+
echo ${{ steps.is_dirty.outputs.status }}
70+
git commit -m "🎨 Prettier"
71+
git push --force --set-upstream "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" ${{ steps.extract_branch.outputs.branch }}
72+
- run: npm test

‎.github/workflows/publish.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Publish Gem
2+
3+
on: [release]
4+
5+
jobs:
6+
build:
7+
name: Build + Publish
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@master
12+
- name: Set up Ruby 2.6
13+
uses: actions/setup-ruby@v1
14+
with:
15+
version: 2.6.x
16+
17+
- name: Publish to GPR
18+
run: |
19+
mkdir -p $HOME/.gem
20+
touch $HOME/.gem/credentials
21+
chmod 0600 $HOME/.gem/credentials
22+
printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
23+
gem build just-the-docs.gemspec
24+
gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
25+
env:
26+
GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
27+
OWNER: pmarsceill
28+
29+
- name: Publish to RubyGems
30+
run: |
31+
mkdir -p $HOME/.gem
32+
touch $HOME/.gem/credentials
33+
chmod 0600 $HOME/.gem/credentials
34+
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
35+
gem build just-the-docs.gemspec
36+
gem push *.gem
37+
env:
38+
GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
39+

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
*.gem
2+
.bundle
3+
.sass-cache
4+
_site
5+
Gemfile.lock
6+
node_modules
7+
.jekyll-cache

‎.prettierignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
package.json
2+
package-lock.json
3+
_site
4+
assets/css/dark-mode-preview.scss
5+
assets/css/just-the-docs.scss
6+
assets/js/vendor/lunr.min.js
7+
assets/js/search-data.json
8+
assets/js/just-the-docs.js

‎.prettierrc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"endOfLine": "lf",
3+
"semi": false,
4+
"singleQuote": false,
5+
"tabWidth": 2,
6+
"trailingComma": "es5"
7+
}
8+

‎.stylelintrc.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"ignoreFiles": [
3+
"assets/css/just-the-docs.scss",
4+
"assets/css/dark-mode-preview.scss",
5+
"_sass/vendor/**/*.scss"
6+
],
7+
"extends": ["stylelint-config-primer", "stylelint-config-prettier"],
8+
"plugins": ["stylelint-prettier"],
9+
"rules": {
10+
"prettier/prettier": true
11+
}
12+
}

0 commit comments

Comments
 (0)