add markdown linter (#2048)

This commit is contained in:
Eugenio Romano
2017-07-05 19:35:07 +02:00
committed by Eugenio Romano
parent 2307b49d44
commit 232375bf82
12 changed files with 156 additions and 94 deletions

View File

@@ -18,6 +18,9 @@
- [Alfresco Api Service](#alfresco-api-service)
- [AppConfigService](#appconfigservice)
* [Different configurations based on environment settings](#different-configurations-based-on-environment-settings)
* [Variable substitution in configuration strings](#variable-substitution-in-configuration-strings)
* [Unit testing](#unit-testing)
- [User Preferences Service](#user-preferences-service)
- [Notification Service](#notification-service)
- [Context Menu directive](#context-menu-directive)
- [Accordion Component](#accordion-component)
@@ -30,7 +33,6 @@
- [AlfrescoTranslationService](#alfrescotranslationservice)
- [Renditions Service](#renditions-service)
- [Build from sources](#build-from-sources)
- [Build from sources](#build-from-sources-1)
- [NPM scripts](#npm-scripts)
- [Demo](#demo)
- [License](#license)
@@ -41,7 +43,7 @@
## Prerequisites
Before you start using this development framework, make sure you have installed all required software and done all the
Before you start using this development framework, make sure you have installed all required software and done all the
necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
@@ -74,17 +76,17 @@ npm install ng2-alfresco-core
## Upload Directive
Allows your components or common HTML elements reacting on File drag and drop in order to upload content.
Allows your components or common HTML elements reacting on File drag and drop in order to upload content.
Used by attaching to an element or component.
### Basic usage
The directive itself does not do any file management process,
The directive itself does not do any file management process,
but collects information on dropped files and raises corresponding events instead.
```html
<div style="width:100px; height:100px"
[adf-upload]="true"
[adf-upload]="true"
[adf-upload-data]="{ some: 'data' }">
Drop files here...
</div>
@@ -113,7 +115,7 @@ Directive supports several modes:
- **drop** mode, where decorated element acts like a drop zone for files (**default** mode)
- **click** mode, where decorated element invokes File Dialog to select files or folders.
It is also possible combining modes together.
It is also possible combining modes together.
```html
<div [adf-upload]="true" mode="['click']">...</div>
@@ -145,7 +147,7 @@ For the click mode you can provide additional attributes for the File Dialog:
#### Drop mode
For the moment upload directive supports only Files (single or multiple).
For the moment upload directive supports only Files (single or multiple).
Support for Folders and `accept` filters is subject to implement.
### Events
@@ -162,7 +164,7 @@ The DOM event is configured to have `bubbling` enabled, so any component up the
```ts
onUploadFiles(e: CustomEvent) {
console.log(e.detail.files);
// your code
}
```
@@ -669,7 +671,6 @@ class MyComponent {
**Important note**: `addTranslationFolder` method redirects **all** languages to a new folder, you may need implementing multiple languages
or copying existing translation files to a new path.
## Renditions Service
* getRenditionsListByNodeId(nodeId: string)
@@ -679,15 +680,6 @@ or copying existing translation files to a new path.
## Build from sources
Alternatively you can build component from sources with the following commands:
```sh
npm install
npm run build
```
## Build from sources
You can build component from sources with the following commands:
```sh