added documantation

marktennyson · Aug 11, 2021 · eb0ff52 · eb0ff52
1 parent c477f57
commit eb0ff52
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 7 deletions.
diff --git a/docs/example.md b/docs/example.md
@@ -2,9 +2,9 @@
 
 ## Sending emails using Falsk-Email
 
-#### Here I have tried to demonstrate some basic functionalities of flask-mailing module.
+## List of Examples 
 
-##### Basic configuration
+### Basic configuration
 
 ```python
 
@@ -45,7 +45,7 @@ async def simple_send():
     return jsonify(status_code=200, content={"message": "email has been sent"})
 ```
 
-##### Send a simple html message
+### Send a simple html message
 ```python
 
 html = """
@@ -67,7 +67,7 @@ async def html_email():
     return jsonify(status_code=200, content={"message": "email has been sent"})
 ```
 
-##### Sending files
+### Sending files
 
 ```python
 @app.get("/mail-file")
@@ -82,7 +82,7 @@ async def mail_file():
     return jsonify(message="email sent")
 ```
 
-##### Using Jinja2 HTML Templates
+### Using Jinja2 HTML Templates
 
 You can enable Jinja2 HTML Template emails by setting the `TEMPLATE_FOLDER` configuration option, and supplying a value (which is just the name of the template file within the `TEMPLATE_FOLDER` dir) for the `template_name` parameter in `Mail.send_message()`. You then can pass a Dict as the `template_body` property of your `Message` object. If you haven't provided the `TEMPLATE_FOLDER` configuration option, then the module will take the app's jinja2 environment for templating and you can use templates from app's default template folder:
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# Flask-mail
+# Flask-mailing
 
 The flask-mailing simple lightweight mail system, sending emails and attachments(individual && bulk)
 
@@ -30,7 +30,7 @@ then the utility will save it in the list or set by default.
 
 
 
-## Writing unittests using Flask-Mail
+## Writing unittests using Flask-Mailing
 Flask mails allows you to write unittest for your application without sending emails to
 non existent email address by mocking the email to be sent. To mock sending out mails, set
 the suppress configuraton to true. Suppress send defaults to False to prevent mocking within applications.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,42 @@
+site_name: Flask-MAILING
+site_url: 
+site_description: flask-mailing 
+dev_addr: 127.0.0.1:8080
+
+theme:
+  name: material
+  palette:
+    scheme: slate
+    primary: teal
+    accent: purple
+
+  icon:
+    repo: fontawesome/brands/github
+
+
+
+repo_name: flask-mailing
+repo_url: https://github.com/marktennyson/flask-mailing
+edit_uri: ''
+
+plugins:
+- search
+- markdownextradata:
+    data: data
+
+markdown_extensions:
+  - toc:
+      permalink: true
+
+  - pymdownx.highlight:
+      linenums: false
+
+  - pymdownx.superfences
+
+nav:
+  - Flask MAILING: index.md
+  - 🔨 Installation: install.md
+  - 🕹 Getting Started: getting-started.md
+  - Example: example.md
+  - Contribution: contribute.md
+