Skip to content

Commit

Permalink
Update docs and mkdocs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
tarsil committed Oct 18, 2023
1 parent ba7c989 commit 62830f8
Show file tree
Hide file tree
Showing 3 changed files with 155 additions and 146 deletions.
4 changes: 2 additions & 2 deletions docs/deployment/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ is very good and also affordable like **render.com** or **Heroku**. It is your c
your needs.

The goal is not to tall you what to do but to give you a simple example in the case you would like to use, for example,
[docker](./docker) and the reason why it is very simple. **Every case is unique**.
[docker](./docker.md) and the reason why it is very simple. **Every case is unique**.

## Esmerald

Expand Down Expand Up @@ -65,7 +65,7 @@ class AppSettings(EsmeraldAPISettings):
if field_name in ("allowed_hosts"):
return [value for value in raw_val.split(",")]
return cls.json_loads(raw_val)

```

This should solve your problems of parsing 😁.
Expand Down
296 changes: 152 additions & 144 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,159 +1,167 @@
site_name: Esmerald
site_description: Highly scalable, performant, easy to learn, easy to code and for every application.
site_url: https://esmerald.dymmond.com
site_description: 🚀 Highly scalable, performant, easy to learn, easy to code and for every application. 🚀
site_url: https://esmerald.dev

theme:
name: "material"
custom_dir: docs/overrides
language: en
palette:
- scheme: "default"
primary: "green"
accent: "orange"
media: "(prefers-color-scheme: light)"
toggle:
icon: "material/lightbulb"
name: "Switch to dark mode"
- scheme: "slate"
media: "(prefers-color-scheme: dark)"
primary: "green"
accent: "orange"
toggle:
icon: "material/lightbulb-outline"
name: "Switch to light mode"
favicon: statics/images/favicon.ico
logo: statics/images/logo-white.svg
features:
- search.suggest
- search.highlight
- content.tabs.link
name: "material"
custom_dir: docs/overrides
language: en
palette:
- scheme: "default"
primary: "green"
accent: "orange"
media: "(prefers-color-scheme: light)"
toggle:
icon: "material/lightbulb"
name: "Switch to dark mode"
- scheme: "slate"
media: "(prefers-color-scheme: dark)"
primary: "green"
accent: "orange"
toggle:
icon: "material/lightbulb-outline"
name: "Switch to light mode"
favicon: statics/images/favicon.ico
logo: statics/images/logo-white.svg
features:
- search.suggest
- search.highlight
- content.tabs.link
- content.code.copy

repo_name: dymmond/esmerald
repo_url: https://github.com/dymmond/esmerald
edit_uri: ""
plugins:
- search
- markdownextradata:
data: data
- search
- meta-descriptions:
export_csv: false
quiet: false
enable_checks: false
min_length: 50
max_length: 160
trim: false
- markdownextradata:
data: data

nav:
- Home: "index.md"
- Esmerald: "esmerald.md"
- Languages:
- en: /
# - pt: /pt/
- Application:
- Esmerald: "application/applications.md"
- Levels: "application/levels.md"
- Settings: "application/settings.md"
- Configurations:
- CORSConfig: "configurations/cors.md"
- CSRFConfig: "configurations/csrf.md"
- SessionConfig: "configurations/session.md"
- StaticFilesConfig: "configurations/staticfiles.md"
- TemplateConfig: "configurations/template.md"
- JWTConfig: "configurations/jwt.md"
- OpenAPIConfig: "configurations/openapi/config.md"
- Routing:
- Router: "routing/router.md"
- Routes: "routing/routes.md"
- Handlers: "routing/handlers.md"
- APIView: "routing/apiview.md"
- OpenAPI Specific:
- Webhooks: "routing/webhooks.md"
- Databases:
- Saffier:
- Motivation: "databases/saffier/motivation.md"
- Models: "databases/saffier/models.md"
- Middleware:
- JWT: "databases/saffier/middleware.md"
- Example: "databases/saffier/example.md"
- Edgy:
- Motivation: "databases/edgy/motivation.md"
- Models: "databases/edgy/models.md"
- Middleware:
- JWT: "databases/edgy/middleware.md"
- Example: "databases/edgy/example.md"
- Mongoz:
- Motivation: "databases/mongoz/motivation.md"
- Documents: "databases/mongoz/documents.md"
- Middleware:
- JWT: "databases/mongoz/middleware.md"
- Example: "databases/mongoz/example.md"
- Interceptors: "interceptors.md"
- Permissions: "permissions.md"
- Middleware: "middleware/middleware.md"
- Dependencies: "dependencies.md"
- Exceptions: "exceptions.md"
- Exception Handlers: "exception-handlers.md"
- Pluggables: "pluggables.md"
- Datastructures: "datastructures.md"
- Password Hashers: "password-hashers.md"
- Responses: "responses.md"
- Background Tasks: "background-tasks.md"
- Lifespan Events: "lifespan-events.md"
- Protocols: "protocols.md"
- Scheduler:
- Asyncz:
- Scheduler: "scheduler/scheduler.md"
- Handler: "scheduler/handler.md"
- Extra, Advanced & Useful:
- Request Data: "extras/request-data.md"
- Upload Files: "extras/upload-files.md"
- Form: "extras/forms.md"
- Body: "extras/body-fields.md"
- Headers: "extras/header-fields.md"
- Cookies: "extras/cookie-fields.md"
- Directives:
- Application Discovery: "directives/discovery.md"
- Directives: "directives/directives.md"
- Custom Directives: "directives/custom-directives.md"
- Shell: "directives/shell.md"
- OpenAPI: "openapi.md"
- WSGI Frameworks: "wsgi.md"
- Test Client: "testclient.md"
- Deployment:
- Intro: "deployment/intro.md"
- Using docker: "deployment/docker.md"
- Third Party Packages: "external.md"
- Esmerald People: "esmerald-people.md"
- Examples & Scaffolds: "examples.md"
- Contributing: "contributing.md"
- Sponsorship: "sponsorship.md"
- Vendors: "vendors.md"
- Release Notes: "release-notes.md"
- Home: "index.md"
- Esmerald: "esmerald.md"
- Languages:
- en: /
# - pt: /pt/
- Application:
- Esmerald: "application/applications.md"
- Levels: "application/levels.md"
- Settings: "application/settings.md"
- Configurations:
- CORSConfig: "configurations/cors.md"
- CSRFConfig: "configurations/csrf.md"
- SessionConfig: "configurations/session.md"
- StaticFilesConfig: "configurations/staticfiles.md"
- TemplateConfig: "configurations/template.md"
- JWTConfig: "configurations/jwt.md"
- OpenAPIConfig: "configurations/openapi/config.md"
- Routing:
- Router: "routing/router.md"
- Routes: "routing/routes.md"
- Handlers: "routing/handlers.md"
- APIView: "routing/apiview.md"
- OpenAPI Specific:
- Webhooks: "routing/webhooks.md"
- Databases:
- Saffier:
- Motivation: "databases/saffier/motivation.md"
- Models: "databases/saffier/models.md"
- Middleware:
- JWT: "databases/saffier/middleware.md"
- Example: "databases/saffier/example.md"
- Edgy:
- Motivation: "databases/edgy/motivation.md"
- Models: "databases/edgy/models.md"
- Middleware:
- JWT: "databases/edgy/middleware.md"
- Example: "databases/edgy/example.md"
- Mongoz:
- Motivation: "databases/mongoz/motivation.md"
- Documents: "databases/mongoz/documents.md"
- Middleware:
- JWT: "databases/mongoz/middleware.md"
- Example: "databases/mongoz/example.md"
- Interceptors: "interceptors.md"
- Permissions: "permissions.md"
- Middleware: "middleware/middleware.md"
- Dependencies: "dependencies.md"
- Exceptions: "exceptions.md"
- Exception Handlers: "exception-handlers.md"
- Pluggables: "pluggables.md"
- Datastructures: "datastructures.md"
- Password Hashers: "password-hashers.md"
- Responses: "responses.md"
- Background Tasks: "background-tasks.md"
- Lifespan Events: "lifespan-events.md"
- Protocols: "protocols.md"
- Scheduler:
- Asyncz:
- Scheduler: "scheduler/scheduler.md"
- Handler: "scheduler/handler.md"
- Extra, Advanced & Useful:
- Request Data: "extras/request-data.md"
- Upload Files: "extras/upload-files.md"
- Form: "extras/forms.md"
- Body: "extras/body-fields.md"
- Headers: "extras/header-fields.md"
- Cookies: "extras/cookie-fields.md"
- Directives:
- Application Discovery: "directives/discovery.md"
- Directives: "directives/directives.md"
- Custom Directives: "directives/custom-directives.md"
- Shell: "directives/shell.md"
- OpenAPI: "openapi.md"
- WSGI Frameworks: "wsgi.md"
- Test Client: "testclient.md"
- Deployment:
- Intro: "deployment/intro.md"
- Using docker: "deployment/docker.md"
- Third Party Packages: "external.md"
- Esmerald People: "esmerald-people.md"
- Examples & Scaffolds: "examples.md"
- Contributing: "contributing.md"
- Sponsorship: "sponsorship.md"
- Vendors: "vendors.md"
- Release Notes: "release-notes.md"
markdown_extensions:
- attr_list
- toc:
permalink: true
- markdown.extensions.codehilite:
guess_lang: false
- mdx_include:
base_path: docs
- admonition
- codehilite
- extra
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format ""
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
- md_in_html
- attr_list
- toc:
permalink: true
- markdown.extensions.codehilite:
guess_lang: false
- mdx_include:
base_path: docs
- admonition
- codehilite
- extra
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format ""
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
- md_in_html

extra:
alternate:
- link: /
name: English
lang: en
# - link: /pt/
# name: Portuguese (Portugal)
# lang: en
alternate:
- link: /
name: English
lang: en
# - link: /pt/
# name: Portuguese (Portugal)
# lang: en

extra_css:
- statics/css/extra.css
- statics/css/custom.css
- statics/css/extra.css
- statics/css/custom.css
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ doc = [
"mkdocs-material>=9.4.4,<10.0.0",
"mdx-include>=1.4.2,<2.0.0",
"mkdocs-markdownextradata-plugin>=0.2.5,<0.3.0",
"mkdocs-meta-descriptions-plugin>=2.3.0",
"mkdocstrings>=0.20.0,<0.30.0",
"pyyaml>=6.0,<7.0.0",
]
Expand Down

0 comments on commit 62830f8

Please sign in to comment.