[docs] add readthedocs doc files

docs/index.md

@@ -0,0 +1,8 @@
+# Movigo library
+
+Movigo is a light and modern JS animation library which makes the creation of DOM element animations easier.
+Movigo use new ECMAScript features and the so-called method chaining technique, and save the state of the animation in each function.
+This means that you can break the chain and create new chains with additional functions by building different animations.
+Library functions allow you to change CSS property values or to set some animation options.
+It is also possible to extend the library with a plugin system that allows you to add functions.
+You can find some use cases on the Movigo [website](https://movigo.cedoor.dev).

docs/install.md

@@ -0,0 +1,2 @@
+# Install
+

docs/plugins/drawer-plugin.md

@@ -0,0 +1 @@
+# Drawer plugin

docs/plugins/focus-plugin.md

@@ -0,0 +1 @@
+# Focus plugin

docs/plugins/list-plugin.md

@@ -0,0 +1 @@
+# List plugin

docs/requirements.txt

@@ -0,0 +1,10 @@
+mkdocs==1.1
+mkdocs-material==4.6.3
+Markdown==3.2.1
+markdown-fenced-code-tabs==1.0.3
+markdown-include==0.5.1
+MarkupSafe==1.1.1
+mkdocs-markdownextradata-plugin==0.1.3
+mkdocs-exclude==1.0.2
+mkdocs-redirects==1.0.0
+mkdocs-git-revision-date-localized-plugin==0.5.0

docs/usage.md

@@ -0,0 +1 @@
+# Usage

index.html

@@ -9,7 +9,8 @@
     <meta name="keywords" lang="en" content="js-animations animations animations-library">
     <meta name="language" content="en"/>
     <meta name="rating" content="general"/>
-    <link rel="icon" type="image/png" href="/resources/icon.png">
+    <link rel="shortcut icon" href="/resources/favicon.ico" type="image/x-icon">
+    <link rel="icon" href="/resources/favicon.ico" type="image/x-icon">
     <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Raleway">
     <link rel="stylesheet" href="./layout.css">
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/styles/zenburn.min.css">

mkdocs.yml

@@ -0,0 +1,32 @@
+site_name: Movigo
+site_url: https://movigo.cedoor.dev
+site_description: Movigo library core with base features to animate your DOM elements.
+site_author: Omar Desogus
+copyright: Copyright (c) 2020 Omar Desogus
+
+extra:
+  support:
+    email: [email protected]
+    website: https://movigo.cedoor.dev
+  search:
+    language: 'en'
+    tokenizer: '[\s]+'
+
+repo_name: movigo/core
+repo_url: https://github.com/movigo/core
+
+theme:
+  name: material
+  palette:
+    primary: blue-grey
+    accent: teal
+nav:
+  - Install: install.md
+  - Usage: usage.md
+  - Plugins: plugins.md
+    - List: plugins/list-plugin.md
+    - Focus: plugins/focus-plugin.md
+    - Drawer: plugins/drawer-plugin.md
+
+plugins:
+  - search

readthedocs.yml

@@ -0,0 +1,15 @@
+# readthedocs.yml
+
+version: 2
+
+build:
+  image: latest
+
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt
+
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: false