Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dewmal committed Jan 24, 2025
1 parent bca9f1e commit 1c3c876
Show file tree
Hide file tree
Showing 6 changed files with 99 additions and 12 deletions.
12 changes: 4 additions & 8 deletions docs/.partials/index-header.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,18 @@
-->

<div class="text-center">
<img class="index-header off-glb" src="./img/pydantic-ai-dark.svg#only-dark" alt="PydanticAI">
<img class="index-header off-glb" src="./img/banner-dark.png#only-dark" alt="PydanticAI">
</div>
<div class="text-center">
<img class="index-header off-glb" src="./img/pydantic-ai-light.svg#only-light" alt="PydanticAI">
<img class="index-header off-glb" src="./img/banner-light.png#only-light" alt="PydanticAI">
</div>
<p class="text-center">
<em>Agent Framework / shim to use Pydantic with LLMs</em>
<em>Empowering Collaboration, Simplifying Complexity</em>
</p>
<p class="text-center">
<a href="https://github.com/ceylonai/ceylon/actions/workflows/ci.yml?query=branch%3Amain">
<img src="https://github.com/ceylonai/ceylon/actions/workflows/ci.yml/badge.svg?event=push" alt="CI">
</a>
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/ceylonai/ceylon">
<img src="https://coverage-badge.samuelcolvin.workers.dev/ceylonai/ceylon.svg" alt="Coverage">
</a>
<a href="https://pypi.python.org/pypi/ceylon">
<img src="https://img.shields.io/pypi/v/ceylon.svg" alt="PyPI">
</a>
Expand All @@ -32,6 +29,5 @@
</p>

<p class="text-emphasis">
PydanticAI is a Python agent framework designed to make it less painful to
build production grade applications with Generative AI.
Ceylon orchestrates AI agents to automate complex tasks through collaborative problem-solving.
</p>
67 changes: 67 additions & 0 deletions docs/extra/tweaks.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
* Copyright 2024-Present, Syigen Ltd. and Syigen Private Limited. All rights reserved.
* Licensed under the Apache License, Version 2.0 (See LICENSE.md or http://www.apache.org/licenses/LICENSE-2.0).
*
*/

/* Revert hue value to that of pre mkdocs-material v9.4.0 */
[data-md-color-scheme="slate"] {
--md-hue: 230;
--md-default-bg-color: hsla(230, 15%, 21%, 1);
}

.hide {
display: none;
}

.text-center {
text-align: center;
}

img.index-header {
width: 70%;
max-width: 500px;
}

.pydantic-pink {
color: #FF007F;
}

.team-blue {
color: #0072CE;
}

.secure-green {
color: #00A86B;
}

.shapes-orange {
color: #FF7F32;
}

.puzzle-purple {
color: #652D90;
}

.wheel-gray {
color: #6E6E6E;
}

.vertical-middle {
vertical-align: middle;
}

.text-emphasis {
font-size: 1rem;
font-weight: 300;
font-style: italic;
}

#version-warning {
min-height: 120px;
margin-bottom: 10px;
}

.mermaid {
text-align: center;
}
Binary file added docs/img/banner-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/banner-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Introduction
# Introduction {.hide}

> Empowering Collaboration, Simplifying Complexity
--8<-- "docs/.partials/index-header.html"

![PyPI - Version](https://img.shields.io/pypi/v/ceylon.svg) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ceylon.svg) ![PyPI Downloads](https://img.shields.io/pypi/dm/ceylon)

[//]: # (![PyPI - Version]&#40;https://img.shields.io/pypi/v/ceylon.svg&#41; ![PyPI - Python Version]&#40;https://img.shields.io/pypi/pyversions/ceylon.svg&#41; ![PyPI Downloads]&#40;https://img.shields.io/pypi/dm/ceylon&#41;)

## Introduction

Expand Down
25 changes: 24 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,31 @@ theme:
locale: en
highlightjs: true

extra_css:
- "extra/tweaks.css"


use_directory_urls: false

plugins:
- search
- tags
- tags

markdown_extensions:
- tables
- admonition
- attr_list
- md_in_html
- pymdownx.details
- pymdownx.caret
- pymdownx.critic
- pymdownx.mark
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.tilde
- pymdownx.inlinehilite
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- sane_lists # this means you can start a list from any number

0 comments on commit 1c3c876

Please sign in to comment.