Browse Source

Updated the documentation

tags/v1.2.0
Cédric Belin 6 months ago
parent
commit
b36ba4cafa
12 changed files with 130 additions and 56 deletions
  1. +5
    -5
      README.md
  2. +20
    -0
      doc/about/license.md
  3. +2
    -2
      doc/about/see_also.md
  4. +35
    -0
      doc/css/mkdocs.css
  5. +0
    -41
      doc/mkdocs.yaml
  6. +1
    -1
      doc/usage.md
  7. +52
    -0
      etc/mkdocs.yaml
  8. +1
    -0
      etc/requirements.txt
  9. +0
    -1
      etc/typedoc.json
  10. +4
    -6
      gulpfile.cjs
  11. +4
    -0
      package.json
  12. +6
    -0
      readthedocs.yaml

+ 5
- 5
README.md View File

@@ -4,13 +4,13 @@
Set up your [GitHub Actions](https://github.com/features/actions) workflow with a specific version of the [Dart SDK](https://dart.dev/tools/sdk).

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

## Development
- [Git repository](https://github.com/cedx/setup-dart)
- [Git repository](https://git.belin.io/cedx/setup-dart)
- [GitHub marketplace](https://github.com/marketplace/actions/setup-dart-action)
- [Submit an issue](https://github.com/cedx/setup-dart/issues)
- [Submit an issue](https://git.belin.io/cedx/setup-dart/issues)

## License
[Setup Dart Action](https://dev.belin.io/setup-dart) is distributed under the MIT License.
[Setup Dart Action](https://docs.belin.io/setup-dart) is distributed under the MIT License.

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

@@ -0,0 +1,20 @@
# MIT License
Copyright © 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.

+ 2
- 2
doc/about/see_also.md View File

@@ -6,8 +6,8 @@
- [GitHub marketplace](https://github.com/marketplace/actions/setup-dart-action)

## Development
- [API reference](https://dev.belin.io/setup-dart/api)
- [Submit an issue](https://github.com/cedx/setup-dart/issues)
- [API reference](https://api.belin.io/setup-dart)
- [Submit an issue](https://git.belin.io/cedx/setup-dart/issues)

## Testing
- [Continuous integration](https://github.com/cedx/setup-dart/actions)


+ 35
- 0
doc/css/mkdocs.css View File

@@ -0,0 +1,35 @@
/* Variables */
:root {
--link-color: orange;
--link-hover-color: gold;
}

/* Main content */
.md-typeset a {
color: var(--link-color);
}

.md-typeset a > code {
background-color: transparent;
}

.md-typeset a:focus,
.md-typeset a:hover {
color: var(--link-hover-color);
}

/* Navigation */
.md-nav__item .md-nav__link--active {
color: var(--link-color);
}

@media screen and (max-width: 76.1875em) {
.md-nav--primary .md-nav__item--active > .md-nav__link {
color: var(--link-color);
}
}

.md-nav__item .md-nav__link--active:focus,
.md-nav__item .md-nav__link--active:hover {
color: var(--link-hover-color);
}

+ 0
- 41
doc/mkdocs.yaml View File

@@ -1,41 +0,0 @@
site_name: Setup Dart Action
site_description: Set up your GitHub Actions workflow with a specific version of the Dart SDK.
site_author: Cédric Belin - cedric@belin.io
site_url: https://dev.belin.io/setup-dart

docs_dir: .
site_dir: ../www

repo_name: GitHub
repo_url: https://github.com/cedx/setup-dart
edit_uri: ''

copyright: Copyright © 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
- meta

nav:
- Overview: index.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: yellow, accent: yellow}

+ 1
- 1
doc/usage.md View File

@@ -45,7 +45,7 @@ steps:
```

!!! tip
A sample workflow can be found in the [`build.yaml`](https://github.com/cedx/setup-dart/blob/master/example/build.yaml) file.
A sample workflow can be found in the [`build.yaml`](https://git.belin.io/cedx/setup-dart/src/branch/master/example/build.yaml) file.

### Matrix
Setup multiple versions of the Dart SDK on multiple operating systems:


+ 52
- 0
etc/mkdocs.yaml View File

@@ -0,0 +1,52 @@
site_name: Setup Dart Action
site_description: Set up your GitHub Actions workflow with a specific version of the Dart SDK.
site_author: Cédric Belin - cedric@belin.io
site_url: https://docs.belin.io/setup-dart

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

repo_name: git.belin.io
repo_url: https://git.belin.io/cedx/setup-dart
edit_uri: ''

copyright: Copyright © 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'

extra_css:
- css/mkdocs.css

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

nav:
- Overview: index.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: yellow
primary: yellow

+ 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",


+ 4
- 6
gulpfile.cjs View File

@@ -1,12 +1,12 @@
const {spawn} = require('child_process');
const del = require('del');
const {promises, readFileSync} = require('fs');
const {readFileSync} = require('fs');
const {dest, series, src, task, watch} = require('gulp');
const replace = require('gulp-replace');
const {delimiter, normalize, resolve} = require('path');

// Initialize the build system.
const _path = 'PATH' in process.env ? process.env.PATH : '';
const _path = process.env.PATH ?? '';
const _vendor = resolve('node_modules/.bin');
if (!_path.includes(_vendor)) process.env.PATH = `${_vendor}${delimiter}${_path}`;

@@ -23,10 +23,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. */


+ 4
- 0
package.json View File

@@ -55,6 +55,10 @@
"test",
"workflow"
],
"repository": {
"type": "git",
"url": "https://git.belin.io/cedx/setup-dart.git"
},
"scripts": {
"coverage": "gulp coverage",
"prepack": "gulp",


+ 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