qontu · tonivj5 · Jul 19, 2017
diff --git a/.gitignore b/.gitignore
@@ -3,9 +3,9 @@ node_modules/*
 npm-debug.log
 
 # TypeScript
-src/*.js
-src/*.map
-src/*.d.ts
+/src/*.js
+/src/*.map
+/src/*.d.ts
 typings
 typings.json
 
@@ -31,9 +31,13 @@ Desktop.ini
 **/*.ngfactory.ts
 
 # Build files
-dist
-.tmp
-build
+/dist/
+/.tmp
+/build
 
 # Debug chrome
 out/chrome
+
+# Docs
+/docs/themes/qontu-doc-theme
+/docs/dist
diff --git a/docs/config.toml b/docs/config.toml
@@ -0,0 +1,68 @@
+baseURL = "https://qontu.github.io/ngx-inline-editor/"
+languageCode = "en-us"
+defaultContentLanguage = "en"
+defaultContentLanguageInSubdir = true
+enableMissingTranslationPlaceholders = true
+
+title = "Inline editor doc"
+theme = "qontu-doc-theme"
+themesdir = "./themes/"
+MetaDataFormat = "yaml"
+
+[params]
+editURL = "https://github.com/qontu/ngx-inline-editor/edit/master/docs/content/"
+noHomeIcon = false # default is false
+noSearch = false # default is false
+showVisitedLinks = true # default is false
+# themeVariant = "green" # choose theme variant "green", "gold" , "blue" (default)
+
+
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+
+#[[menu.shortcuts]]
+#name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
+#identifier = "hugodoc"
+#url = "https://gohugo.io/"
+#weight = 2
+
+[languages]
+[languages.en]
+    weight = 20
+    languageName = "English"
+    languageCode = "en-us"
+    description = "Documentation of ngx-inline-editor component."
+    copyright = "All rights reserved."
+
+[[languages.en.menu.shortcuts]]
+name = "<i class='fa fa-bullhorn'></i> Authors"
+url = "/en/authors"
+weight = 3
+
+[[languages.en.menu.shortcuts]]
+pre = "<h3>More</h3>"
+name = "<i class='fa fa-github'></i> Github repo"
+identifier = "ds"
+url = "https://github.com/qontu/ngx-inline-editor"
+weight = 1
+
+
+[languages.es]
+    weight = 10
+    languageName = "Español"
+    languageCode = "es-es"
+    description = "Documentación del componente ngx-inline-editor."
+    copyright = "Todos los derechos reservados"
+
+[[languages.es.menu.shortcuts]]
+name = "<i class='fa fa-bullhorn'></i> Autores"
+url = "/es/authors"
+weight = 3
+
+
+[[languages.es.menu.shortcuts]]
+pre = "<h3>Más</h3>"
+name = "<i class='fa fa-github'></i> Repo de Github"
+identifier = "ds"
+url = "https://github.com/qontu/ngx-inline-editor"
+weight = 1
diff --git a/docs/content/_header.en.md b/docs/content/_header.en.md
@@ -0,0 +1,8 @@
+---
+date: "2017-06-18T13:58:45+02:00"
+description: ""
+title: "Header"
+
+---
+
+Inline editor's docs
diff --git a/docs/content/_header.es.md b/docs/content/_header.es.md
@@ -0,0 +1,8 @@
+---
+date: "2017-06-18T13:58:45+02:00"
+description: ""
+title: "Header"
+
+---
+
+Doc. del Inline editor
diff --git a/docs/content/_index.en.md b/docs/content/_index.en.md
@@ -0,0 +1,9 @@
+---
+title: Home
+type: page
+weight: 100
+---
+
+# ngx-inline-editor
+[![npm version](https://badge.fury.io/js/%40qontu%2Fngx-inline-editor.svg)](https://badge.fury.io/js/%40qontu%2Fngx-inline-editor)
+
diff --git a/docs/content/_index.es.md b/docs/content/_index.es.md
@@ -0,0 +1,10 @@
+---
+title: Home
+type: page
+weight: 100
+---
+
+# ngx-inline-editor
+[![npm version](https://badge.fury.io/js/%40qontu%2Fngx-inline-editor.svg)](https://badge.fury.io/js/%40qontu%2Fngx-inline-editor)
+
+{{<plunker link="https://embed.plnkr.co/hdXFaRhVeJ4RvwFl1oGa/">}}
diff --git a/docs/content/authors/_index.en.md b/docs/content/authors/_index.en.md
@@ -0,0 +1,9 @@
+---
+title: Authors
+type: page
+weight: 700
+---
+
+[Carlos Caballero](hhttps://github.com/caballerog)
+
+[Antonio Villena](https://github.com/xxxtonixxx)
diff --git a/docs/content/authors/_index.es.md b/docs/content/authors/_index.es.md
@@ -0,0 +1,9 @@
+---
+title: Autores
+type: page
+weight: 700
+---
+
+[Carlos Caballero](hhttps://github.com/caballerog)
+
+[Antonio Villena](https://github.com/xxxtonixxx)
diff --git a/docs/content/development/_index.en.md b/docs/content/development/_index.en.md
@@ -0,0 +1,14 @@
+---
+title: Development
+type: page
+weight: 650
+---
+
+1. To generate all `*.js`, `*.js.map` and `*.d.ts` files:
+
+    `npm run build`
+
+2. To debug :
+
+    `npm run build:watch`
+
diff --git a/docs/content/development/_index.es.md b/docs/content/development/_index.es.md
@@ -0,0 +1,22 @@
+---
+title: Desarrolladores
+type: page
+weight: 650
+---
+Este componente no usa dependencias de terceros por lo que es ultra ligero {{<emoticon name="wink" >}}
+
+
+Como herramienta para automatizar procesos usamos `gulp` y para crear los bundles `rollup`.
+
+Si quieres colaborar en el desarrollo te indicaré los pasos que usamos:
+
+1. Para compilar el código 
+    `npm run build`
+    - Esto creará una carpeta `dist/` con el código transpilado y bundleado.
+
+
+2. Para iniciar el modo debug:
+    `npm run debug`
+     - Esto copiará los ficheros `src/**/*.ts` al directorio `dist/` y permitirá que puedas usar directamente los ficheros typescript, esto aporta una gran facilidad a la hora de debuggear, ya que no necesitas los `.map`.
+     - Una vez iniciado, ejecuta el comando `yarn link`
+     - Y luego en tu proyecto de prueba `yarn link @qontu/ngx-inline-editor`
diff --git a/docs/content/getting-started/_index.en.md b/docs/content/getting-started/_index.en.md
@@ -0,0 +1,20 @@
+---
+title: Getting started
+type: page
+weight: 100
+---
+
+## Welcome to our docs!
+
+**ngx-inline-editor**  is a library developed in Angular 4 (version 4.x.x), 
+with this component you are able to create editable elements. This technique is also known as _click-to-edit_ or _edit-in-place_.
+This component is based on ideas of [angular-xeditable](https://github.com/vitalets/angular-xeditable) which is developed in AngularJS.
+
+## Version
+Angular 4 is now stable. Therefore, if encountering errors using this lib, ensure your version of Angular is compatible. 
+The current version used to develop this lib is angular4 `^4.0.0`.
+
+## Dependencies
+Basically it does not depend on any libraries except Angular4 itself. 
+
+For themes you need to include [Twitter Bootstrap](http://v4-alpha.getbootstrap.com/) and [FontAwesome](http://fontawesome.io/) in your project.
diff --git a/docs/content/getting-started/_index.es.md b/docs/content/getting-started/_index.es.md
@@ -0,0 +1,22 @@
+---
+title: Cómo empezar
+type: page
+weight: 100
+---
+
+## Bienvenido a nuestra documentacion!
+
+**ng-inline-editor** es una biblioteca desarrollada usando Angular 4 (version 4.x.x). Éste componente te permite crear elementos editables.
+Esta técnica también es conocida como _click-to-edit_ o _edit-in-place_.
+Este componente está basado en ideas de [angular-xeditable](https://github.com/vitalets/angular-xeditable), el cual está desarrollado en AngularJS.
+
+## Version
+
+La versión de Angular 4 es estable. Por lo tanto, si tienes algún problema usando esta biblioteca, asegurate de que tu versión es compatible.
+La version la cual está siendo utilizada para desarrollar esta biblioteca es angular4 `4.4.4`.
+
+## Dependencias
+
+No depende de ninguna biblioteca excepto Angular4.
+
+Para los temas necesitas incluir  [Twitter Bootstrap](http://v4-alpha.getbootstrap.com/) y [FontAwesome](http://fontawesome.io/) en tu proyecto.
diff --git a/docs/content/getting-started/features.en.md b/docs/content/getting-started/features.en.md
@@ -0,0 +1,27 @@
+---
+title: Features
+type: page
+weight: 105
+---
+
+Feature's component:
+
+- [x] text
+- [x] textarea
+- [x] select
+- [ ] checkbox
+- [ ] radio
+- [ ] date
+- [ ] time
+- [x] datetime
+- [ ] html5 inputs
+  - [x] pattern
+  - [x] number
+  - [x] range
+- [ ] typeahead
+- [ ] ui-select
+- [ ] complex form
+- [ ] editable row
+- [ ] editable column
+- [ ] editable table
+- [x] themes
diff --git a/docs/content/getting-started/features.es.md b/docs/content/getting-started/features.es.md
@@ -0,0 +1,27 @@
+---
+title: Características
+type: page
+weight: 105
+---
+
+Estas son las características que dispone actualmente el componente:
+
+- [x] text
+- [x] textarea
+- [x] select
+- [ ] checkbox
+- [ ] radio
+- [ ] date
+- [ ] time
+- [x] datetime
+- [ ] html5 inputs
+  - [x] pattern
+  - [x] number
+  - [x] range
+- [ ] typeahead
+- [ ] ui-select
+- [ ] formularios complejos
+- [ ] filas editables
+- [ ] columnas editables
+- [ ] tablas editables
+- [x] temas
diff --git a/docs/content/getting-started/setup.en.md b/docs/content/getting-started/setup.en.md
@@ -0,0 +1,21 @@
+---
+date: 2017-06-17T20:55:11+02:00
+title: Setup
+type: page
+weight: 200
+---
+
+## Installation
+A recommended way of installing **ngx-inline-editor** with [npm](https://www.npmjs.com/package/@qontu/ngx-inline-editor) using the following command:
+
+`npm i @qontu/ngx-inline-editor --save`
+
+## Configure styles
+
+Include the basic theme or configure your own styles. To use the basic theme using *angular-cli*, you can import the css rules into *angular-cli*'s file `src/styles.css` using this line:
+
+`@import '~@qontu/ngx-inline-editor/themes/bootstrap.css'`
+
+{{% notice info %}}
+We use some classes of [Twitter Bootstrap](http://v4-alpha.getbootstrap.com/) and [FontAwesome](http://fontawesome.io/) to perform the icons of buttons. You need to include them or customize your own style.
+{{% /notice %}}
diff --git a/docs/content/getting-started/setup.es.md b/docs/content/getting-started/setup.es.md
@@ -0,0 +1,22 @@
+---
+date: 2017-06-17T20:55:11+02:00
+title: Instalación
+type: page
+weight: 200
+---
+
+## Instalación
+
+Una forma recomendable de instalar **ngx-inline-editor** es con [npm](https://www.npmjs.com/package/@qontu/ngx-inline-editor), usando el siguiente comando:
+
+`npm i @qontu/ngx-inline-editor --save`
+
+## Configurar estilos
+
+Puedes tanto incluir tus propios estilos como incluir el tema básico. Para utilizar el básico con *angular-cli*, puedes importarlo al fichero `src/styles.css` con el siguiente comando:
+
+`@import '~@qontu/ngx-inline-editor/themes/bootstrap.css'`
+
+{{% notice info %}}
+Usamos ciertas clases de [Twitter Bootstrap](http://v4-alpha.getbootstrap.com/) y [FontAwesome](http://fontawesome.io/) para representar los iconos de los botones. Puedes tanto incluirlos o customizar los tuyos propios.
+{{% /notice %}}
diff --git a/docs/content/license/_index.en.md b/docs/content/license/_index.en.md
@@ -0,0 +1,7 @@
+---
+title: License
+type: page
+weight: 750
+---
+
+MIT License (See the [LICENSE](https://github.com/qontu/ngx-inline-editor/blob/master/LICENSE.MD) file for the full text).
diff --git a/docs/content/license/_index.es.md b/docs/content/license/_index.es.md
@@ -0,0 +1,7 @@
+---
+title: Licencia
+type: page
+weight: 750
+---
+
+MIT License (See the [LICENSE](https://github.com/qontu/ngx-inline-editor/blob/master/LICENSE.MD) file for the full text).