Skip to content

Commit 6fbc7e8

Browse files
dewmaldewmal
committed
Update doc
1 parent 676c7b4 commit 6fbc7e8

File tree

5 files changed

+141
-0
lines changed

5 files changed

+141
-0
lines changed

‎docs/.overrides/main.html

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
{% if page and page.meta and page.meta.title %}
5+
<title>{{ page.meta.title }}</title>
6+
{% elif page and page.title and not page.is_homepage %}
7+
<title>{{ page.title }} - {{ config.site_name }}</title>
8+
{% else %}
9+
<title>{{ config.site_name }}</title>
10+
{% endif %}
11+
12+
<meta charset="utf-8">
13+
<meta name="viewport" content="width=device-width, initial-scale=1">
14+
15+
<!-- Your custom CSS -->
16+
<link rel="stylesheet" href="{{ 'css/custom.css'|url }}">
17+
18+
<!-- Material theme CSS (if using material theme) -->
19+
{% if config.theme.name == 'material' %}
20+
<link rel="stylesheet" href="{{ 'assets/stylesheets/material.css'|url }}">
21+
{% endif %}
22+
</head>
23+
<body>
24+
<header>
25+
<nav>
26+
<!-- Your custom navigation -->
27+
<div class="nav-wrapper">
28+
<a href="{{ nav.homepage.url|url }}" class="brand">{{ config.site_name }}</a>
29+
<ul class="nav-links">
30+
{% for nav_item in nav %}
31+
<li {% if nav_item.active %}class="active" {% endif %}>
32+
<a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
33+
</li>
34+
{% endfor %}
35+
</ul>
36+
</div>
37+
</nav>
38+
</header>
39+
40+
<main>
41+
<div class="content-wrapper">
42+
{% block content %}
43+
{{ page.content }}
44+
{% endblock %}
45+
</div>
46+
</main>
47+
48+
<footer>
49+
<!-- Your custom footer -->
50+
<div class="footer-content">
51+
<p>&copy; {{ config.copyright }}</p>
52+
</div>
53+
</footer>
54+
55+
<!-- MkDocs JavaScript -->
56+
{% for path in config.extra_javascript %}
57+
<script src="{{ path|url }}"></script>
58+
{% endfor %}
59+
</body>
60+
</html>

‎docs/.partials/index-header.html

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!--
2+
~ Copyright 2024-Present, Syigen Ltd. and Syigen Private Limited. All rights reserved.
3+
~ Licensed under the Apache License, Version 2.0 (See LICENSE.md or http://www.apache.org/licenses/LICENSE-2.0).
4+
~
5+
-->
6+
7+
<div class="text-center">
8+
<img class="index-header off-glb" src="./img/pydantic-ai-dark.svg#only-dark" alt="PydanticAI">
9+
</div>
10+
<div class="text-center">
11+
<img class="index-header off-glb" src="./img/pydantic-ai-light.svg#only-light" alt="PydanticAI">
12+
</div>
13+
<p class="text-center">
14+
<em>Agent Framework / shim to use Pydantic with LLMs</em>
15+
</p>
16+
<p class="text-center">
17+
<a href="https://github.com/ceylonai/ceylon/actions/workflows/ci.yml?query=branch%3Amain">
18+
<img src="https://github.com/ceylonai/ceylon/actions/workflows/ci.yml/badge.svg?event=push" alt="CI">
19+
</a>
20+
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/ceylonai/ceylon">
21+
<img src="https://coverage-badge.samuelcolvin.workers.dev/ceylonai/ceylon.svg" alt="Coverage">
22+
</a>
23+
<a href="https://pypi.python.org/pypi/ceylon">
24+
<img src="https://img.shields.io/pypi/v/ceylon.svg" alt="PyPI">
25+
</a>
26+
<a href="https://github.com/ceylonai/ceylon">
27+
<img src="https://img.shields.io/pypi/pyversions/pydantic-ai.svg" alt="versions">
28+
</a>
29+
<a href="https://github.com/ceylonai/ceylon/blob/master/LICENSE">
30+
<img src="https://img.shields.io/github/license/ceylonai/ceylon.svg" alt="license">
31+
</a>
32+
</p>
33+
34+
<p class="text-emphasis">
35+
PydanticAI is a Python agent framework designed to make it less painful to
36+
build production grade applications with Generative AI.
37+
</p>

‎docs/favicon.ico

15 KB
Binary file not shown.

‎docs/img/logo.png

160 KB
Loading

‎mkdocs.yml

+44
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,50 @@
11
site_name: "Ceylon: A Multi-Agent System (MAS)"
22
site_url: "https://ceylon.ai"
3+
4+
copyright: © SYIGEN LTD. 2023 to present
5+
extra:
6+
# hide the "Made with Material for MkDocs" message
7+
generator: false
38
theme:
49
name: "material"
10+
# custom_dir: docs/.overrides
11+
palette:
12+
- media: "(prefers-color-scheme)"
13+
scheme: default
14+
primary: purple
15+
accent: pink
16+
toggle:
17+
icon: material/lightbulb
18+
name: "Switch to light mode"
19+
- media: "(prefers-color-scheme: light)"
20+
scheme: default
21+
primary: purple
22+
accent: pink
23+
toggle:
24+
icon: material/lightbulb-outline
25+
name: "Switch to dark mode"
26+
- media: "(prefers-color-scheme: dark)"
27+
scheme: slate
28+
primary: dark-purple
29+
accent: pink
30+
toggle:
31+
icon: material/lightbulb-auto-outline
32+
name: "Switch to system preference"
33+
features:
34+
- search.suggest
35+
- search.highlight
36+
- content.tabs.link
37+
- content.code.annotate
38+
- content.code.copy
39+
- content.code.select
40+
- navigation.path
41+
# - navigation.expand
42+
- navigation.indexes
43+
- navigation.sections
44+
- navigation.tracking
45+
- toc.follow
46+
# - navigation.tabs # don't use navbar tabs
47+
logo: "img/logo.png"
48+
favicon: "favicon.ico"
549

650
use_directory_urls: false

0 commit comments

Comments
 (0)