Browse Source

Updated the documentation

tags/v4.1.0
Cédric Belin 2 months ago
parent
commit
eb8b68662e
10 changed files with 70 additions and 37 deletions
  1. +6
    -7
      README.md
  2. +20
    -0
      doc/about/license.md
  3. +6
    -7
      doc/about/see_also.md
  4. +1
    -1
      doc/index.md
  5. +3
    -1
      doc/usage/api.md
  6. +0
    -1
      etc/compodoc.yaml
  7. +24
    -15
      etc/mkdocs.yaml
  8. +1
    -0
      etc/requirements.txt
  9. +3
    -5
      gulpfile.cjs
  10. +6
    -0
      readthedocs.yaml

+ 6
- 7
README.md View File

@@ -1,19 +1,18 @@
# Web Storage for Angular
![Runtime](https://img.shields.io/npm/dependency-version/@cedx/ngx-webstorage/peer/@angular/core.svg) ![Release](https://img.shields.io/npm/v/@cedx/ngx-webstorage.svg) ![License](https://img.shields.io/npm/l/@cedx/ngx-webstorage.svg) ![Downloads](https://img.shields.io/npm/dt/@cedx/ngx-webstorage.svg) ![Dependencies](https://david-dm.org/cedx/ngx-webstorage.js.svg) ![Coverage](https://coveralls.io/repos/github/cedx/ngx-webstorage.js/badge.svg) ![Build](https://github.com/cedx/ngx-webstorage.js/workflows/build/badge.svg)
![Runtime](https://img.shields.io/npm/dependency-version/@cedx/ngx-webstorage/peer/@angular/core.svg) ![Release](https://img.shields.io/npm/v/@cedx/ngx-webstorage.svg) ![License](https://img.shields.io/npm/l/@cedx/ngx-webstorage.svg) ![Downloads](https://img.shields.io/npm/dt/@cedx/ngx-webstorage.svg) ![Dependencies](https://david-dm.org/cedx/ngx-webstorage.svg) ![Coverage](https://coveralls.io/repos/github/cedx/ngx-webstorage/badge.svg) ![Build](https://github.com/cedx/ngx-webstorage/workflows/build/badge.svg)

[Angular](https://angular.io) services for interacting with the [Web Storage](https://developer.mozilla.org/en-US/docs/Web/API/Storage), implemented in [TypeScript](https://www.typescriptlang.org).

> This library is packaged as [ECMAScript modules](https://nodejs.org/api/esm.html).

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

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

## License
[Web Storage for Angular](https://dev.belin.io/ngx-webstorage.js) is distributed under the MIT License.
[Web Storage for Angular](https://docs.belin.io/ngx-webstorage) is distributed under the MIT License.

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

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

+ 6
- 7
doc/about/see_also.md View File

@@ -1,15 +1,14 @@
# See also

## Development
- [API reference](https://dev.belin.io/ngx-webstorage.js/api)
- [GitHub package](https://github.com/cedx/ngx-webstorage.js/packages)
- [API reference](https://api.belin.io/ngx-webstorage)
- [npm package](https://www.npmjs.com/package/@cedx/ngx-webstorage)
- [Submit an issue](https://github.com/cedx/ngx-webstorage.js/issues)
- [Submit an issue](https://git.belin.io/cedx/ngx-webstorage/issues)

## Testing
- [Continuous integration](https://github.com/cedx/ngx-webstorage.js/actions)
- [Code coverage](https://coveralls.io/github/cedx/ngx-webstorage.js)
- [Continuous integration](https://github.com/cedx/ngx-webstorage/actions)
- [Code coverage](https://coveralls.io/github/cedx/ngx-webstorage)

## Other implementations
- Dart: [Web Storage for Dart](https://dev.belin.io/webstorage.dart)
- JavaScript: [Web Storage for JS](https://dev.belin.io/webstorage.js)
- Dart: [Web Storage for Dart](https://docs.belin.io/webstorage.dart)
- JavaScript: [Web Storage for JS](https://docs.belin.io/webstorage.js)

+ 1
- 1
doc/index.md View File

@@ -1,5 +1,5 @@
# Web Storage <small>for Angular</small>
![Runtime](https://img.shields.io/npm/dependency-version/@cedx/ngx-webstorage/peer/@angular/core.svg) ![Release](https://img.shields.io/npm/v/@cedx/ngx-webstorage.svg) ![License](https://img.shields.io/npm/l/@cedx/ngx-webstorage.svg) ![Downloads](https://img.shields.io/npm/dt/@cedx/ngx-webstorage.svg) ![Dependencies](https://david-dm.org/cedx/ngx-webstorage.js.svg) ![Coverage](https://coveralls.io/repos/github/cedx/ngx-webstorage.js/badge.svg) ![Build](https://github.com/cedx/ngx-webstorage.js/workflows/build/badge.svg)
![Runtime](https://img.shields.io/npm/dependency-version/@cedx/ngx-webstorage/peer/@angular/core.svg) ![Release](https://img.shields.io/npm/v/@cedx/ngx-webstorage.svg) ![License](https://img.shields.io/npm/l/@cedx/ngx-webstorage.svg) ![Downloads](https://img.shields.io/npm/dt/@cedx/ngx-webstorage.svg) ![Dependencies](https://david-dm.org/cedx/ngx-webstorage.svg) ![Coverage](https://coveralls.io/repos/github/cedx/ngx-webstorage/badge.svg) ![Build](https://github.com/cedx/ngx-webstorage/workflows/build/badge.svg)

[Angular](https://angular.io) services for interacting with the [Web Storage](https://developer.mozilla.org/en-US/docs/Web/API/Storage),
implemented in [TypeScript](https://www.typescriptlang.org).


+ 3
- 1
doc/usage/api.md View File

@@ -1,5 +1,7 @@
path: blob/master
---
path: src/branch/master
source: src/storage.ts
---

# Programming interface
This package provides two services dedicated to the Web Storage: the `LocalStorage` and `SessionStorage` classes.


+ 0
- 1
etc/compodoc.yaml View File

@@ -1,6 +1,5 @@
customFavicon: doc/img/favicon.ico
disablePrivate: true
gaSite: auto
hideGenerator: true
name: Web Storage for Angular
output: doc/api


doc/mkdocs.yaml → etc/mkdocs.yaml View File

@@ -1,30 +1,33 @@
site_name: Web Storage for Angular
site_description: Angular services for interacting with the Web Storage, implemented in TypeScript.
site_author: Cédric Belin - cedric@belin.io
site_url: https://dev.belin.io/ngx-webstorage.js
site_url: https://docs.belin.io/ngx-webstorage

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

repo_name: GitHub
repo_url: https://github.com/cedx/ngx-webstorage.js
repo_name: git.belin.io
repo_url: https://git.belin.io/cedx/ngx-webstorage
edit_uri: ''

copyright: Copyright &copy; 2017 - 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'}
- 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
@@ -34,11 +37,17 @@ nav:
- Iteration: usage/iteration.md
- Events: usage/events.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: blue, accent: red}
features:
- instant
icon:
logo: fontawesome/solid/book-reader
repo: fontawesome/brands/git-alt
name: material
palette:
accent: red
primary: blue

+ 1
- 0
etc/requirements.txt View File

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

+ 3
- 5
gulpfile.cjs View File

@@ -6,7 +6,7 @@ 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}`;

@@ -30,10 +30,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('compodoc', ['--config=etc/compodoc.yaml', `--gaID=${process.env.GOOGLE_ANALYTICS_ID}`]);
await _exec('mkdocs', ['build', '--config-file=doc/mkdocs.yaml']);
return del(['doc/about/changelog.md', 'doc/about/license.md', 'www/mkdocs.yaml']);
await _exec('compodoc', ['--config=etc/compodoc.yaml']);
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