-
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.
- Loading branch information
Showing
6 changed files
with
266 additions
and
0 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,18 @@ | ||
matrix: | ||
- name: Markdown | ||
aspell: | ||
lang: en | ||
dictionary: | ||
wordlists: | ||
- .github/workflows/config/.wordList.txt | ||
encoding: utf-8 | ||
pipeline: | ||
- pyspelling.filters.markdown: | ||
- pyspelling.filters.html: | ||
comments: false | ||
ignores: | ||
- code | ||
- pre | ||
sources: | ||
- '**/*.md' | ||
default_encoding: utf-8 |
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 @@ | ||
|
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,141 @@ | ||
default: false # includes/excludes all rules by default | ||
|
||
# Heading levels should only increment by one level at a time <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md001> | ||
MD001: true | ||
|
||
# Heading style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md003> | ||
MD003: true | ||
|
||
# Unordered list style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md004> | ||
MD004: true | ||
|
||
# Inconsistent indentation for list items at the same level <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md005> | ||
MD005: true | ||
|
||
# Consider starting bulleted lists at the beginning of the line <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md006> | ||
MD006: true | ||
|
||
# Unordered list indentation <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md007> | ||
MD007: true | ||
|
||
# Trailing spaces <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md009> | ||
MD009: true | ||
|
||
# Hard tabs <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md010> | ||
MD010: true | ||
|
||
# Reversed link syntax <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md011> | ||
MD011: true | ||
|
||
# Multiple consecutive blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md012> | ||
MD012: true | ||
|
||
# Line length <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md013> | ||
MD013: false | ||
|
||
# Dollar signs used before commands without showing output <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md014> | ||
MD014: false | ||
|
||
# No space after hash on atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md018> | ||
MD018: true | ||
|
||
# Multiple spaces after hash on atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md019> | ||
MD019: true | ||
|
||
# No space inside hashes on closed atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md020> | ||
MD020: true | ||
|
||
# Multiple spaces inside hashes on closed atx style heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md021> | ||
MD021: true | ||
|
||
# Headings should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md022> | ||
MD022: true | ||
|
||
# Headings must start at the beginning of the line <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md023> | ||
MD023: true | ||
|
||
# Multiple headings with the same content <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024> | ||
MD024: | ||
allow_different_nesting: true | ||
|
||
# Multiple top level headings in the same document <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md025> | ||
MD025: true | ||
|
||
# Trailing punctuation in heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026> | ||
MD026: true | ||
|
||
# Multiple spaces after blockquote symbol <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md027> | ||
MD027: true | ||
|
||
# Blank line inside blockquote <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md028> | ||
MD028: false | ||
|
||
# Ordered list item prefix <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029> | ||
MD029: | ||
style: 'one_or_ordered' | ||
|
||
# Spaces after list markers <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md030> | ||
MD030: true | ||
|
||
# Fenced code blocks should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md031> | ||
MD031: true | ||
|
||
# Lists should be surrounded by blank lines <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md032> | ||
MD032: true | ||
|
||
# Inline HTML <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md033> | ||
MD033: false | ||
|
||
# Bare URL used <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md034> | ||
MD034: true | ||
|
||
# Horizontal rule style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md035> | ||
MD035: | ||
style: '---' | ||
|
||
# Emphasis used instead of a heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md036> | ||
MD036: true | ||
|
||
# Spaces inside emphasis markers <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md037> | ||
MD037: true | ||
|
||
# Spaces inside code span elements <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md038> | ||
MD038: true | ||
|
||
# Spaces inside link text <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md039> | ||
MD039: true | ||
|
||
# Fenced code blocks should have a language specified <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md040> | ||
MD040: true | ||
|
||
# First line in file should be a top level heading <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md041> | ||
MD041: true | ||
|
||
# No empty links <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md042> | ||
MD042: true | ||
|
||
# Required heading structure <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md043> | ||
MD043: false | ||
|
||
# Proper names should have the correct capitalization <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md044> | ||
MD044: false | ||
|
||
# Images should have alternate text (alt text) <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md045> | ||
MD045: false | ||
|
||
# Code block style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md046> | ||
MD046: | ||
style: 'fenced' | ||
|
||
# Files should end with a single newline character <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md047> | ||
MD047: true | ||
|
||
# Code fence style <https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md048> | ||
MD048: | ||
style: 'backtick' | ||
|
||
# Custom rules: | ||
CHANGELOG-RULE-001: true | ||
CHANGELOG-RULE-002: true | ||
CHANGELOG-RULE-003: true | ||
CHANGELOG-RULE-004: 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 |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Image Actions will run in the following scenarios: | ||
# - on Pull Requests containing images (not including forks) | ||
# - on pushing of images to `main` (for forks) | ||
# - on demand (https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/) | ||
# - at 11 PM every Sunday in anything gets missed with any of the above scenarios | ||
# For Pull Requests, the images are added to the PR. | ||
# For other scenarios, a new PR will be opened if any images are compressed. | ||
name: Compress images | ||
on: | ||
pull_request: | ||
paths: | ||
- '**.jpg' | ||
- '**.jpeg' | ||
- '**.png' | ||
- '**.webp' | ||
push: | ||
branches: | ||
- master # we don't have a main branch #why it not work now? #not it | ||
paths: | ||
- '**.jpg' | ||
- '**.jpeg' | ||
- '**.png' | ||
- '**.webp' | ||
workflow_dispatch: | ||
schedule: | ||
- cron: '00 23 * * 0' | ||
jobs: | ||
build: | ||
name: calibreapp/image-actions | ||
runs-on: ubuntu-latest | ||
# Only run on main repo on and PRs that match the main repo. | ||
if: | | ||
github.repository == 'frc6506/docs' && | ||
(github.event_name != 'pull_request' || | ||
github.event.pull_request.head.repo.full_name == github.repository) | ||
steps: | ||
- name: Checkout Branch | ||
uses: actions/checkout@v3 | ||
- name: Compress Images | ||
id: calibre | ||
uses: calibreapp/image-actions@main | ||
with: | ||
githubToken: ${{ secrets.GITHUB_TOKEN }} | ||
# For non-Pull Requests, run in compressOnly mode and we'll PR after. | ||
compressOnly: ${{ github.event_name != 'pull_request' }} | ||
- name: Create Pull Request | ||
# If it's not a Pull Request then commit any changes as a new PR. | ||
if: | | ||
github.event_name != 'pull_request' && | ||
steps.calibre.outputs.markdown != '' | ||
uses: peter-evans/create-pull-request@v3 | ||
with: | ||
title: Auto Compress Images | ||
branch-suffix: timestamp | ||
commit-message: Compress Images | ||
body: ${{ steps.calibre.outputs.markdown }} | ||
labels: enhancement, dozer | ||
|
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,30 @@ | ||
name: Markdown Linter | ||
on: | ||
- push | ||
- pull_request | ||
|
||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
|
||
jobs: | ||
lint-changelog: | ||
name: Lint markdown files | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Check out code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Lint files | ||
uses: docker://avtodev/markdown-lint:v1 # fastest way | ||
with: | ||
#rules: '.github/workflows/config/markdownlintConfig.js' #custom rules | ||
config: '.github/workflows/config/markdownlintConfig.yml' #main config | ||
ignore: 'pages/aboutPages.md' # multiple files must be separated with single space | ||
|
||
# Or using current repository as action: | ||
|
||
# - name: Lint changelog file | ||
# uses: avto-dev/markdown-lint@v1 | ||
# with: | ||
# rules: '/lint/rules/changelog.js' | ||
# config: '/lint/config/changelog.yml' | ||
# args: './' |
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,18 @@ | ||
name: Spellcheck Action | ||
on: | ||
- push | ||
- pull_request | ||
|
||
jobs: | ||
build: | ||
name: Spellcheck | ||
runs-on: ubuntu-latest | ||
steps: | ||
# The checkout step | ||
- uses: actions/checkout@v3 | ||
- uses: rojopolis/spellcheck-github-actions@0.22.1 | ||
name: Spellcheck | ||
with: | ||
config_path: .github/workflows/config/.spellConfig.yml # put path to configuration file here | ||
task_name: Markdown | ||
|