added documents skeleton

mostafa · Apr 29, 2018 · f6e938d · f6e938d
1 parent dae4f73
commit f6e938d
Show file tree

Hide file tree

Showing 16 changed files with 649 additions and 0 deletions.
diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,7 @@
+# About
+
+gREST is designed and developed by: **Mostafa Moradian**
+
+Email: [mostafamoradian0@gmail.com](mailto:mostafamoradian0@gmail.com)
+
+GitHub Profile: [https://github.com/mostafa](https://github.com/mostafa)
diff --git a/docs/application.md b/docs/application.md
@@ -0,0 +1 @@
+# gREST Application Structure
diff --git a/docs/authentication_authorization.md b/docs/authentication_authorization.md
@@ -0,0 +1 @@
+# Authentication & Authorization
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -0,0 +1 @@
+# Configuration
diff --git a/docs/custom_endpoints.md b/docs/custom_endpoints.md
@@ -0,0 +1 @@
+# Custom Endpoints
diff --git a/docs/deployment.md b/docs/deployment.md
@@ -0,0 +1 @@
+# Deployment
diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico
diff --git a/docs/img/gREST-logo.png b/docs/img/gREST-logo.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](http://mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs help` - Print this help message.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/docs/license.md b/docs/license.md
diff --git a/docs/logging.md b/docs/logging.md
@@ -0,0 +1 @@
+# Logging
diff --git a/docs/models.md b/docs/models.md
@@ -0,0 +1 @@
+# Models
diff --git a/docs/routes.md b/docs/routes.md
@@ -0,0 +1 @@
+# Routes
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -0,0 +1 @@
+# Tutorial
diff --git a/docs/views.md b/docs/views.md
@@ -0,0 +1 @@
+# Views
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,20 @@
+site_name: gREST
+pages:
+  - Home: index.md
+  - Tutorial: tutorial.md
+  - Application: application.md
+  - Configuration: configuration.md
+  - Authentication & Authorization: authentication_authorization.md
+  - Views: views.md
+  - Routes: routes.md
+  - Models: models.md
+  - Custom Endpoints: custom_endpoints.md
+  - Deployment: deployment.md
+  - License: license.md
+  - About: about.md
+theme:
+  name: material
+  palette:
+    primary: 'Blue Grey'
+    accent: 'Amber'
+  logo: 'img/gREST-logo.png'