Skip to content

Commit 5adca57

Browse files
committed
Some doc fixes
1 parent 3158e85 commit 5adca57

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

docs/index.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,29 @@
1515
Ellar is a lightweight ASGI framework for building efficient and scalable server-side python application.
1616
It supports both OOP (Object-Oriented Programming) and FP (Functional Programming)
1717

18-
Ellar is built around [Starlette]()(ASGI toolkit) which processes all the HTTP request and background tasks. Although, there is a high level
18+
Ellar is built around [Starlette](https://www.starlette.io/)(ASGI toolkit) which processes all the HTTP request and background tasks. Although, there is a high level
1919
of abstraction, some concepts of Starlette are still supported.
2020

2121
## Inspiration
22-
Ellar was heavily inspired by [NestJS]() in its simplicity in usage while managing complex project structures and application.
23-
It also adopted some concepts of [FastAPI]() in handling request parameters and data serialization with pydantic.
22+
Ellar was heavily inspired by [NestJS](https://docs.nestjs.com/) in its simplicity in usage while managing complex project structures and application.
23+
It also adopted some concepts of [FastAPI](https://fastapi.tiangolo.com/) in handling request parameters and data serialization with pydantic.
2424
With that said, the aim of Ellar focuses on high level of abstraction of framework APIs, project structures, architectures and speed of handling requests.
2525

2626
## Installation
27-
To get started, you need to scaffold a project using [Ellar-CLI]() toolkit. This is recommended for first-time user.
27+
To get started, you need to scaffold a project using [Ellar-CLI](https://eadwincode.github.io/ellar-cli/) toolkit. This is recommended for first-time user.
2828
The scaffolded project is more like a guide to project setup.
2929

3030
```shell
3131
$(venv) pip install ellar[standard]
3232
$(venv) ellar new project-name
3333
```
3434

35+
### NB:
36+
Some shells may treat square braces (`[` and `]`) as special characters. If that's the case here, then use a quote around the characters to prevent unexpected shell expansion.
37+
```shell
38+
pip install "ellar[standard]"
39+
```
40+
3541
### Py36 Support
3642
For python3.6 users,
3743
```shell

mkdocs.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ theme:
1313
primary: pink
1414
accent: pink
1515
toggle:
16-
icon: material/toggle-switch
16+
icon: material/lightbulb
1717
name: Switch to dark mode
1818

1919
- media: "(prefers-color-scheme: dark)"
2020
scheme: slate
2121
primary: pink
2222
accent: pink
2323
toggle:
24-
icon: material/toggle-switch-off-outline
24+
icon: material/lightbulb-outline
2525
name: Switch to light mode
2626

2727
language: en
@@ -41,9 +41,9 @@ nav:
4141
- Providers: overview/providers.md
4242
- Modules: overview/modules.md
4343
- Middlewares: overview/middleware.md
44-
- Exception Filters: overview/exception-filters.md
44+
- Exception Filters: overview/exception_filters.md
4545
- Guards: overview/guards.md
46-
- Custom Decorators: overview/custom-decorators.md
46+
- Custom Decorators: overview/custom_decorators.md
4747
- How-to Guides:
4848
- Parsing Request Inputs:
4949
- Body: overview/how-to-guide/parsing-inputs/body.md
@@ -78,5 +78,7 @@ markdown_extensions:
7878
- codehilite
7979
- admonition
8080
- pymdownx.superfences
81+
- toc:
82+
permalink: true
8183
extra_css:
8284
- stylesheets/extra.css

0 commit comments

Comments
 (0)