Skip to content

Commit 73e9b6c

Browse files
committed
Move the documentation to the GitHub wiki
1 parent 1ff1635 commit 73e9b6c

16 files changed

+403
-461
lines changed

Diff for: .github/workflows/ci.yaml

-24
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,3 @@ jobs:
2424
run: npm test
2525
env:
2626
NODE_ENV: test
27-
deploy:
28-
needs: test
29-
runs-on: ubuntu-latest
30-
steps:
31-
- name: Fetch sources
32-
uses: actions/checkout@v4
33-
- name: Set up Node.js
34-
uses: actions/setup-node@v4
35-
with:
36-
cache: npm
37-
node-version: 22
38-
- name: Set up Python
39-
uses: actions/setup-python@v5
40-
with:
41-
cache: pip
42-
python-version: 3.12
43-
- name: Install dependencies
44-
run: |
45-
npm ci
46-
pip install --requirement=etc/requirements.txt
47-
- name: Deploy documentation
48-
run: |
49-
npx gulp doc
50-
mkdocs gh-deploy --config-file=etc/mkdocs.yaml --force

Diff for: .gitignore

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
/**/.DS_Store
22
/.idea/
3-
/docs/api/
43
/etc/http-client.private.env.json
54
/lib/
65
/node_modules/
76
/npm-debug.log
87
/var/
9-
/www/
8+
/wiki/

Diff for: README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,11 @@ This package allows you to apply the [`php_strip_whitespace()`](https://www.php.
66
either using the command line or through a [Gulp](https://gulpjs.com) plugin.
77

88
## Documentation
9-
- [User guide](https://docs.belin.io/php-minifier)
10-
- [API reference](https://docs.belin.io/php-minifier/api)
9+
- [User guide](https://github.com/cedx/php-minifier/wiki)
10+
- [Examples](https://github.com/cedx/php-minifier/tree/main/example)
1111

1212
## Development
1313
- [Git repository](https://github.com/cedx/php-minifier)
14-
- [npm package](https://www.npmjs.com/package/@cedx/php-minifier)
1514
- [Submit an issue](https://github.com/cedx/php-minifier/issues)
1615

1716
## License

Diff for: docs/favicon.ico

-19.3 KB
Binary file not shown.

Diff for: docs/favicon.svg

-1
This file was deleted.

Diff for: docs/index.md

-17
This file was deleted.

Diff for: docs/installation.md

-28
This file was deleted.

Diff for: docs/styles.css

-4
This file was deleted.

Diff for: docs/usage/cli.md

-71
This file was deleted.

Diff for: docs/usage/gulp.md

-73
This file was deleted.

Diff for: etc/mkdocs.yaml

-59
This file was deleted.

Diff for: etc/requirements.txt

-1
This file was deleted.

Diff for: etc/typedoc.js

-10
This file was deleted.

Diff for: gulpfile.js

-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import {cp} from "node:fs/promises";
21
import {env} from "node:process";
32
import {deleteAsync} from "del";
43
import {$} from "execa";
@@ -15,12 +14,6 @@ export function clean() {
1514
return deleteAsync(["lib", "var/**/*", "www"]);
1615
}
1716

18-
// Builds the documentation.
19-
export async function doc() {
20-
for (const file of ["CHANGELOG.md", "LICENSE.md"]) await cp(file, `docs/${file.toLowerCase()}`);
21-
return $`typedoc --options etc/typedoc.js`;
22-
}
23-
2417
// Performs the static analysis of source code.
2518
export async function lint() {
2619
await $`tsc --project tsconfig.json`;
@@ -33,12 +26,6 @@ export async function publish() {
3326
for (const action of [["tag"], ["push", "origin"]]) await $`git ${action} v${pkg.version}`;
3427
}
3528

36-
// Starts the development server.
37-
export async function serve() {
38-
await doc();
39-
return $({stdio: "inherit"})`mkdocs serve --config-file=etc/mkdocs.yaml`;
40-
}
41-
4229
// Runs the test suite.
4330
export function test() {
4431
env.NODE_ENV = "test";

0 commit comments

Comments
 (0)