Skip to content
Closed
Show file tree
Hide file tree
Changes from all 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
15 changes: 4 additions & 11 deletions .github/workflows/build-assets.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,13 @@ jobs:

runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Setting up node ${{ matrix.node-version }}
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- name: Cache npm modules
uses: actions/cache@v2
with:
# npm cache files are stored in `~/.npm` on Linux/macOS
path: ~/.npm
key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.OS }}-node-
${{ runner.OS }}-
cache: npm
cache-dependency-path: public/template/package-lock.json
- run: npm ci
working-directory: ./public/template
- run: npm run release
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
validate-json:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Validate language file
uses: docker://orrosenblatt/validate-json-action:latest
env:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ node_modules/
sources.json
markdown/
public/template/package-lock.json
.phpunit.result.cache
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,31 @@ For the language switch to work, you also need to index the translations with `p

**These index actions are done automatically for changed files only (much faster!) as part of `php docs.php sources:update`.** Typically you'd only need to run the full indexing the first time setting up a mirror or clone.

## Markdown alerts

GitHub-style alert blockquotes render as the existing `.c-callout` boxes:

```markdown
> [!NOTE]
> Extra detail for the reader.

> [!TIP]
> A shortcut or recommended approach.

> [!IMPORTANT]
> Something easy to miss.

> [!WARNING]
> Risk or breaking change.

> [!CAUTION]
> Stronger warning than WARNING.
```

Spaces inside the marker (`[! NOTE]`) are accepted. Tables and other CommonMark features are unchanged.

Page-level git history (last change and contributors) is already shown on documentation pages from the search/history index. A separate site-wide docs changelog UI is not part of this feature.

## Building assets

From the `public/template/` directory, first load the dependencies with `npm install`.
Expand Down
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
"voku/stop-words": "^2.0"
},
"require-dev": {
"ext-intl": "*"
"ext-intl": "*",
"phpunit/phpunit": "^9.6"
},
"autoload": {
"psr-4": {
Expand Down
Loading
Loading