Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions .github/cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
{
"version": "0.2",
"language": "en",
"caseSensitive": false,
"words": [
"CakePHP",
"VitePress",
"php",
"datetime",
"varchar",
"postgresql",
"mysql",
"sqlite",
"webroot",
"csrf",
"xss",
"cakephp",
"bake",
"phinx",
"hasher",
"middlewares",
"namespaced",
"phpunit",
"composable",
"autowiring",
"stringable",
"arrayable",
"timestampable",
"paginator",
"Enqueue",
"dequeue",
"nullable",
"accessor",
"mutator",
"minphpversion",
"phpversion",
"XAMPP",
"WAMP",
"MAMP",
"controllername",
"actionname",
"Datamapper",
"webservices",
"nginx",
"apache",
"httpd",
"lighttpd",
"mbstring",
"simplexml",
"Laragon",
"composer",
"phar",
"paginate",
"startup",
"endfor",
"endwhile",
"sidebar",
"blocks",
"rewrite",
"before",
"called",
"sites",
"example",
"Classes",
"Redirect",
"Layout"
],
"ignoreRegExpList": [
"/\\$[a-zA-Z_][a-zA-Z0-9_]*/g",
"/[a-zA-Z]+::[a-zA-Z]+/g",
"/<[^>]+>/g",
"/`[^`]+`/g",
"/```[\\s\\S]*?```/g",
"/\\b[A-Z][a-z]+(?:[A-Z][a-z]+)+\\b/g",
"/\\b[a-z]+_[a-z_]+\\b/g",
"/\\bhttps?:\\/\\/[^\\s]+/g",
"/\\[[a-z]\\][a-z]+/g",
"/\\b[A-Z][a-z]+\\b/g",
"/\\b(true|false|null|while|for|if|else)\\b/g"
],
Comment thread
josbeir marked this conversation as resolved.
"languageSettings": [
{
"languageId": "*",
"locale": "en",
"dictionaries": ["en", "softwareTerms", "php"]
},
{
"languageId": "*",
"locale": "ja",
"allowCompoundWords": true
}
],
"overrides": [
{
"filename": "**/docs/ja/**/*.md",
"language": "ja",
"ignoreRegExpList": [
"/[\\p{Script=Hiragana}\\p{Script=Katakana}\\p{Script=Han}]+/gu"
Comment thread
josbeir marked this conversation as resolved.
Outdated
]
}
],
"ignorePaths": [
"node_modules/**",
".temp/**",
"dist/**",
"**/*.min.js",
"**/*.lock"
]
}
71 changes: 71 additions & 0 deletions .github/markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"default": true,
"MD001": false,
"MD010": false,
"MD012": false,
"MD013": false,
"MD022": false,
"MD024": false,
"MD025": false,
"MD026": false,
"MD028": false,
"MD030": false,
"MD031": false,
"MD032": false,
"MD033": false,
"MD034": false,
"MD040": false,
"MD041": false,
"MD046": false,
"MD047": false,
"MD051": false,
"MD055": false,
"MD056": false,
"MD059": false,
"MD060": false,
"line-length": false,
"no-inline-html": {
"allowed_elements": [
"Badge",
"div",
"span",
"br",
"style",
"details",
"summary",
"table",
"thead",
"tbody",
"tr",
"th",
"td",
"img",
"a",
"svg",
"path",
"figure",
"p"
]
},
"no-duplicate-heading": false,
Comment thread
josbeir marked this conversation as resolved.
Outdated
"single-h1": false,
"no-bare-urls": false,
"fenced-code-language": false,
"no-hard-tabs": false,
"no-multiple-blanks": false,
"blanks-around-headings": false,
"blanks-around-fences": false,
"blanks-around-lists": false,
"no-blanks-blockquote": false,
"code-block-style": false,
"list-marker-space": false,
"commands-show-output": false,
"heading-increment": false,
"no-trailing-punctuation": false,
"single-trailing-newline": false,
"link-fragments": false,
"table-pipe-style": false,
"table-column-count": false,
"descriptive-link-text": false,
"table-column-style": false
Comment thread
josbeir marked this conversation as resolved.
Outdated
}
69 changes: 69 additions & 0 deletions .github/workflows/docs-validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Documentation Validation

on:
pull_request:
paths:
- 'docs/**'
- '.github/**'
- 'toc_*.json'
- 'config.js'

jobs:
js-lint:
name: Validate JavaScript Files
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4
Comment thread
josbeir marked this conversation as resolved.
Outdated

- name: Validate config.js syntax
run: node --check config.js

json-lint:
name: Validate JSON Files
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4
Comment thread
josbeir marked this conversation as resolved.
Outdated

- name: Validate JSON syntax
run: |
for file in toc_*.json; do
if ! jq empty "$file" 2>/dev/null; then
echo "Invalid JSON: $file"
exit 1
fi
echo "✅ Valid: $file"
done

markdown-lint:
name: Lint Markdown
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4
Comment thread
josbeir marked this conversation as resolved.
Outdated

- name: Lint markdown files
uses: articulate/actions-markdownlint@v1
with:
config: .github/markdownlint.json
files: 'docs/**/*.md'
ignore: 'node_modules'

spell-check:
name: Spell Check
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4
Comment thread
josbeir marked this conversation as resolved.
Outdated

- name: Check spelling
uses: streetsidesoftware/cspell-action@v5
with:
files: 'docs/**/*.md'
config: '.github/cspell.json'
incremental_files_only: true