Browse Source

Updated the documentation

tags/v11.0.0
Cédric Belin 7 months ago
parent
commit
11df1b97d7
9 changed files with 88 additions and 57 deletions
  1. +5
    -6
      README.md
  2. +20
    -0
      doc/about/license.md
  3. +4
    -5
      doc/about/see_also.md
  4. +0
    -41
      doc/mkdocs.yaml
  5. +50
    -0
      etc/mkdocs.yaml
  6. +1
    -0
      etc/requirements.txt
  7. +0
    -1
      etc/typedoc.json
  8. +2
    -4
      gulpfile.cjs
  9. +6
    -0
      readthedocs.yaml

+ 5
- 6
README.md View File

@@ -6,14 +6,13 @@
> This library is packaged as [ECMAScript modules](https://nodejs.org/api/esm.html).

## Documentation
- [User guide](https://dev.belin.io/gulp-php-minify)
- [API reference](https://dev.belin.io/gulp-php-minify/api)
- [User guide](https://docs.belin.io/gulp-php-minify)
- [API reference](https://api.belin.io/gulp-php-minify)

## Development
- [Git repository](https://github.com/cedx/gulp-php-minify)
- [GitHub package](https://github.com/cedx/gulp-php-minify/packages)
- [Git repository](https://git.belin.io/cedx/gulp-php-minify)
- [npm package](https://www.npmjs.com/package/@cedx/gulp-php-minify)
- [Submit an issue](https://github.com/cedx/gulp-php-minify/issues)
- [Submit an issue](https://git.belin.io/cedx/gulp-php-minify/issues)

## License
[Gulp-PHP-Minify](https://dev.belin.io/gulp-php-minify) is distributed under the MIT License.
[Gulp-PHP-Minify](https://docs.belin.io/gulp-php-minify) is distributed under the MIT License.

+ 20
- 0
doc/about/license.md View File

@@ -0,0 +1,20 @@
# MIT License
Copyright © 2016 - 2020 Cédric Belin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

+ 4
- 5
doc/about/see_also.md View File

@@ -1,10 +1,9 @@
# See also

## Development
- [API reference](https://dev.belin.io/gulp-php-minify/api)
- [GitHub package](https://github.com/cedx/gulp-php-minify/packages)
- [API reference](https://api.belin.io/gulp-php-minify)
- [npm package](https://www.npmjs.com/package/@cedx/gulp-php-minify)
- [Submit an issue](https://github.com/cedx/gulp-php-minify/issues)
- [Submit an issue](https://git.belin.io/cedx/gulp-php-minify/issues)
- [Gulp API docs](https://gulpjs.com/docs/en/api/concepts)

## Testing
@@ -12,5 +11,5 @@
- [Code coverage](https://coveralls.io/github/cedx/gulp-php-minify)

## Other implementations
- Dart: [Grinder-PHP-Minify](https://dev.belin.io/grinder-php-minify)
- PHP: [Robo-PHP-Minify](https://dev.belin.io/robo-php-minify)
- Dart: [Grinder-PHP-Minify](https://docs.belin.io/grinder-php-minify)
- PHP: [Robo-PHP-Minify](https://docs.belin.io/robo-php-minify)

+ 0
- 41
doc/mkdocs.yaml View File

@@ -1,41 +0,0 @@
site_name: Gulp-PHP-Minify
site_description: Gulp plug-in minifying PHP source code by removing comments and whitespace.
site_author: Cédric Belin - cedric@belin.io
site_url: https://dev.belin.io/gulp-php-minify

docs_dir: .
site_dir: ../www

repo_name: GitHub
repo_url: https://github.com/cedx/gulp-php-minify
edit_uri: ''

copyright: Copyright © 2016 - 2020 Cédric Belin
google_analytics:
- !!python/object/apply:os.getenv [GOOGLE_ANALYTICS_ID]
- auto

extra:
social:
- {type: globe, link: 'https://belin.io'}
- {type: github, link: 'https://github.com/cedx'}
- {type: twitter, link: 'https://twitter.com/cedxbelin'}
- {type: linkedin, link: 'https://linkedin.com/in/cedxbelin'}

markdown_extensions:
- admonition
- codehilite

nav:
- Overview: index.md
- Installation: installation.md
- Usage: usage.md
- About:
- Changelog: about/changelog.md
- License: about/license.md
- See also: about/see_also.md

theme:
name: material
favicon: img/favicon.ico
palette: {primary: red, accent: red}

+ 50
- 0
etc/mkdocs.yaml View File

@@ -0,0 +1,50 @@
site_name: Gulp-PHP-Minify
site_description: Gulp plug-in minifying PHP source code by removing comments and whitespace.
site_author: Cédric Belin - cedric@belin.io
site_url: https://docs.belin.io/gulp-php-minify

docs_dir: ../doc
site_dir: ../www

repo_name: git.belin.io
repo_url: https://git.belin.io/cedx/gulp-php-minify
edit_uri: ''

copyright: Copyright © 2016 - 2020 Cédric Belin
extra:
social:
- icon: fontawesome/solid/globe
link: 'https://belin.io'
- icon: fontawesome/brands/github
link: 'https://github.com/cedx'
- icon: fontawesome/brands/twitter
link: 'https://twitter.com/cedxbelin'
- icon: fontawesome/brands/linkedin
link: 'https://linkedin.com/in/cedxbelin'

markdown_extensions:
- admonition
- codehilite
- meta
- toc:
permalink: true

nav:
- Overview: index.md
- Installation: installation.md
- Usage: usage.md
- About:
- License: about/license.md
- See also: about/see_also.md

theme:
favicon: img/favicon.ico
features:
- instant
icon:
logo: fontawesome/solid/book-reader
repo: fontawesome/brands/git-alt
name: material
palette:
accent: red
primary: red

+ 1
- 0
etc/requirements.txt View File

@@ -0,0 +1 @@
mkdocs-material

+ 0
- 1
etc/typedoc.json View File

@@ -1,6 +1,5 @@
{
"excludePrivate": true,
"gaSite": "auto",
"gitRevision": "master",
"hideGenerator": true,
"mode": "file",


+ 2
- 4
gulpfile.cjs View File

@@ -27,10 +27,8 @@ task('coverage', () => _exec('coveralls', ['var/lcov.info']));

/** Builds the documentation. */
task('doc', async () => {
for (const path of ['CHANGELOG.md', 'LICENSE.md']) await promises.copyFile(path, `doc/about/${path.toLowerCase()}`);
await _exec('typedoc', ['--gaID', process.env.GOOGLE_ANALYTICS_ID, '--options', 'etc/typedoc.json']);
await _exec('mkdocs', ['build', '--config-file=doc/mkdocs.yaml']);
return del(['doc/about/changelog.md', 'doc/about/license.md', 'www/mkdocs.yaml']);
await _exec('typedoc', ['--options', 'etc/typedoc.json']);
return _exec('mkdocs', ['build', '--config-file=etc/mkdocs.yaml']);
});

/** Fixes the coding standards issues. */


+ 6
- 0
readthedocs.yaml View File

@@ -0,0 +1,6 @@
version: 2
mkdocs:
configuration: etc/mkdocs.yaml
python:
install:
- requirements: etc/requirements.txt

Loading…
Cancel
Save