changed logo and document fonts

eadwinCode · eadwinCode · commit ceda55bd1e4b · 2023-04-10T22:10:45.000+01:00
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 [![PyPI version](https://img.shields.io/pypi/v/ellar.svg)](https://pypi.python.org/pypi/ellar)
 [![PyPI version](https://img.shields.io/pypi/pyversions/ellar.svg)](https://pypi.python.org/pypi/ellar)
 
-## Introduction
+## **Introduction**
 
 Ellar is a lightweight ASGI framework for building efficient and scalable server-side python applications.
 It supports both OOP (Object-Oriented Programming) and FP (Functional Programming)
@@ -19,7 +19,7 @@ Ellar is based on [Starlette (ASGI toolkit)](https://www.starlette.io/), a light
 While Ellar provides a high level of abstraction on top of Starlette, it still incorporates some of its features, as well as those of FastAPI. 
 If you are familiar with these frameworks, you will find it easy to understand and use Ellar.
 
-## Features Summary
+## **Features Summary**
 
 - **Easy to Use**: Ellar has a simple and intuitive API that makes it easy to get started with building a fast and scalable web applications or web APIs in Python.
 - **Dependency Injection (DI)**: It comes with DI system makes it easy to manage dependencies and reduce coupling between components.
@@ -31,13 +31,13 @@ If you are familiar with these frameworks, you will find it easy to understand a
 - **Modularity**: Ellar follows a modular architecture inspired by NestJS, making it easy to organize your code into reusable modules.
 - **Asynchronous programming**: It allows you to takes advantage of Python's `async/await` feature to write efficient and fast code that can handle large numbers of concurrent requests
 
-## Dependencies
+## **Dependencies**
 - Python >= 3.7
 - Starlette
 - Injector
 - Pydantic
 
-## Installation
+## **Installation**
 ### Poetry Installation
 For [Poetry](https://python-poetry.org/) usages
 
@@ -51,11 +51,10 @@ For normal pip installation
 pip install ellar-cli
 ```
 
-## Create a project
+## Creating a project
 To create an ellar project, you need to have a `pyproject.toml` available on your root directory.
 This is necessary for ellar to store some `metadata` about your project. 
 
-### Create a project
 For Pip Users, you need to create `pyproject.toml` file
 ```shell
 ellar new carsite
@@ -66,7 +65,7 @@ run the ellar create project cli command,
 ellar create-project carsite
 ```
 
-## Run your project
+## **Run your project**
 Ellar runs [UVICORN - ASGI Server](https://www.uvicorn.org/) under the hood.
 ```shell
 ellar runserver --reload
@@ -78,14 +77,14 @@ Now go to [http://127.0.0.1:8000](http://127.0.0.1:8000)
 
 For more info on Ellar CLI, click [here](https://github.com/eadwinCode/ellar-cli)
 
-## Create a project module
+## **Adding a project module**
 A project module is a project app defining a group of controllers or services including templates and static files.
 So, now we have a project created, lets add an app to the project.
 ```shell
 ellar create-module car
 ```
 
-## Add Schema
+## **Add Schema**
 In `car/schema.py`, lets add some serializer for car input and output data
 ```python
 from ellar.serializer import Serializer
@@ -100,7 +99,7 @@ class RetrieveCarSerializer(CarSerializer):
     pk: str
 ```
 
-## Add Services
+## **Add Services**
 In `car/services.py`, lets create a dummy repository `CarDummyDB` to manage our car data.
 ```python
 import typing as t
@@ -153,7 +152,7 @@ class CarDummyDB:
         if idx >= 0:
             return self._data.pop(idx)
 ```
-## Add Controller
+## **Add Controller**
 In `car/controllers.py`, lets create `CarController`
 
 ```python
@@ -201,7 +200,7 @@ class CarController(ControllerBase):
         return self.car_db.list()
 
 ```
-## Register Service and Controller
+## **Register Service and Controller**
 In `car/module.py`, lets register `CarController` and `CarDummyDB`
 
 ```python
@@ -225,7 +224,7 @@ class CarModule(ModuleBase):
         pass
 ```
 
-## Registering Module
+## **Registering Module**
 Ellar is not aware of `CarModule` yet, so we need to add it to the `modules` list of `ApplicationModule` at the `carsite/root_module.py`.
 ```python
 from ellar.common import Module, exception_handler
@@ -243,7 +242,7 @@ class ApplicationModule(ModuleBase):
         return JSONResponse(dict(detail="Resource not found."))
 
 ```
-## Enabling OpenAPI Docs
+## **Enabling OpenAPI Docs**
 To start up openapi, we need to go back to project folder in the `server.py`
 then add the following below.
 ```python
@@ -280,7 +279,7 @@ Now we can test our API at [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/do
 Please ensure your server is running
 ![Swagger UI](docs/img/car_api.png)
 
-## HTML Templating
+## **HTML Templating**
 Ellar has built-in support for Jinja2, which is a popular template engine for HTML. This feature allows for easy and efficient HTML templating similar to that of Flask. Jinja2 can be used to create reusable templates, and to insert dynamic data into HTML pages. It also has support for template inheritance, control structures, and other useful features that can help to simplify and streamline the process of creating HTML templates.
 
 ```html
diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="#" target="blank"><img src="img/EllarLogoIconOnly.png" width="200" alt="Ellar Logo" /></a>
+  <a href="#" target="blank"><img src="img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
 </p>
 
 <p align="center"> Ellar - Python ASGI web framework for building fast, efficient and scalable RESTAPIs and server-side application. </p>
@@ -11,23 +11,23 @@
 [![PyPI version](https://img.shields.io/pypi/pyversions/ellar.svg)](https://pypi.python.org/pypi/ellar)
 
 ---
-## Introduction
+## **Introduction**
 Ellar is a lightweight ASGI framework for building efficient and scalable server-side python applications.
 It supports both OOP (Object-Oriented Programming) and FP (Functional Programming)
 
 Ellar is based on [Starlette (ASGI toolkit)](https://www.starlette.io/), a lightweight ASGI framework/toolkit well-suited for developing asynchronous web services in Python. 
 And while Ellar provides a high level of abstraction on top of Starlette, it still incorporates some of its features, as well as those of FastAPI. 
 If you are familiar with these frameworks, you will find it easy to understand and use Ellar.
 
-## Inspiration
+## **Inspiration**
 Ellar was deeply influenced by [NestJS](https://docs.nestjs.com/) for its ease of use and ability to handle complex project structures and applications. 
 Additionally, it took some concepts from [FastAPI](https://fastapi.tiangolo.com/) in terms of request parameter handling and data serialization with Pydantic. 
 
 With that said, the objective of Ellar is to offer a high level of abstraction in its framework APIs, along with a well-structured project setup, an object-oriented approach to web application design, 
 the ability to adapt to any desired software architecture, and ultimately, speedy request handling.
 
 
-## Features Summary
+## **Features Summary**
 
 - **Easy to Use**: Ellar has a simple and intuitive API that makes it easy to get started with building a fast and scalable web applications or web APIs with Python.
 - **Dependency Injection (DI)**: It comes with DI system makes it easy to manage dependencies and reduce coupling between components.
@@ -39,7 +39,7 @@ the ability to adapt to any desired software architecture, and ultimately, speed
 - **Modularity**: Ellar follows a modular architecture inspired by NestJS, making it easy to organize your code into reusable modules.
 - **Asynchronous programming**: It allows you to takes advantage of Python's `async/await` feature to write efficient and fast code that can handle large numbers of concurrent requests
 
-## Installation
+## **Installation**
 To get started, you need to scaffold a project using [Ellar-CLI](https://eadwincode.github.io/ellar-cli/) toolkit. This is recommended for a first-time user.
 The scaffolded project is more like a guide to project setup.
 
@@ -61,13 +61,13 @@ $(venv) ellar runserver --reload
 Open your browser and navigate to [`http://localhost:8000/`](http://localhost:8000/).
 ![Swagger UI](img/ellar_framework.png)
 
-## Dependency Summary
+## **Dependency Summary**
 - `Python >= 3.7`
 - `Starlette`
 - `Pydantic`
 - `Injector`
 
-## Status
+## **Status**
 
 Project is still in development
 
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -1,3 +1,3 @@
 .md-header {
-    background-color: #40405e !important;
+    background-color: rgba(0, 0, 0, 0.86) !important;
 }
diff --git a/docs/throttling.md b/docs/throttling.md
@@ -6,7 +6,7 @@ To get started, you'll need to install the `ellar-throttler` package.
 $(venv) pip install ellar-throttler
 ```
 
-## ThrottlerModule
+## **ThrottlerModule**
 
 The `ThrottlerModule` is the main entry point for this package, and can be used in a synchronous or asynchronous manner. 
 All the needs to be passed is the `ttl`, the time to live in seconds for the request tracker, and the `limit`, 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: Ellar
+site_name: ellar
 site_description: Ellar - Python ASGI web framework for building fast, efficient and scalable RESTAPIs and server-side application.
 site_url: https://github.com/eadwinCode/ellar
 repo_name: eadwinCode/ellar
@@ -40,8 +40,8 @@ theme:
         icon: material/lightbulb-outline
         name: Switch to light mode
   font:
-    text: Roboto
-    code: Roboto Mono
+    text: Noto Sans
+    code: Fira Code
   language: en
   logo: img/Icon.svg
   favicon: img/Icon.svg

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`.md-header {`
`2`		`- background-color: #40405e !important;`
	`2`	`+ background-color: rgba(0, 0, 0, 0.86) !important;`
`3`	`3`	`}`