From 0f0f8f3864e91d990eeae8f7325877ae7ffd3238 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fl=C3=A1vio=20Juvenal?= Date: Thu, 20 Jun 2024 16:46:36 -0300 Subject: [PATCH] Add a robot icon and improve nav --- README.md | 2 +- docs/images/robot-happy-outline.svg | 1 + docs/index.md | 2 +- mkdocs.yml | 14 +++++++++----- 4 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 docs/images/robot-happy-outline.svg diff --git a/README.md b/README.md index 41044fa..6539f63 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![Django CI](https://github.com/vintasoftware/django-ai-assistant/actions/workflows/django.yml/badge.svg)](https://github.com/vintasoftware/django-ai-assistant/actions/workflows/django.yml) [![Node CI](https://github.com/vintasoftware/django-ai-assistant/actions/workflows/node.yml/badge.svg)](https://github.com/vintasoftware/django-ai-assistant/actions/workflows/node.yml) -# django-ai-assistant +# django-ai-assistant ![docs/images/robot-happy-outline.svg] Combine the power of LLMs with Django's productivity to build intelligent applications. Let AI Assistants call methods from Django's side and do anything your users need! diff --git a/docs/images/robot-happy-outline.svg b/docs/images/robot-happy-outline.svg new file mode 100644 index 0000000..83c6110 --- /dev/null +++ b/docs/images/robot-happy-outline.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index d15166c..f1bc789 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Django AI Assistant +# Django AI Assistant :material-robot-happy-outline: Combine the power of Large Language Models with Django's productivity to build intelligent applications. diff --git a/mkdocs.yml b/mkdocs.yml index 49799e1..2106549 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,9 @@ edit_uri: blob/main/docs/ theme: name: material + icon: + logo: material/robot-happy-outline + favicon: images/robot-happy-outline.svg features: - navigation.tabs palette: @@ -43,13 +46,14 @@ markdown_extensions: - toc: permalink: true - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg nav: - - Home: - - Overview: index.md - - Usage: - - Get Started: get-started.md - - Tutorial: tutorial.md + - Home: index.md + - Get Started: get-started.md + - Tutorial: tutorial.md - Reference: - helpers.assistants: assistants-ref.md - helpers.use_cases: use-cases-ref.md