📝 Add Jina's QA Bot to the docs to help people that want to ask quick questions (#263)

Co-authored-by: yanlong.wang <yanlong.wang@naiver.org>
Co-authored-by: Han Xiao <han.xiao@jina.ai>
This commit is contained in:
Sebastián Ramírez 2022-04-16 11:24:53 +02:00 committed by GitHub
parent 6d969c5845
commit e523e1e4c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 0 deletions

31
docs/overrides/main.html Normal file
View File

@ -0,0 +1,31 @@
{% extends "base.html" %}
{%- block scripts %}
{{ super() }}
<script src="https://cdn.jsdelivr.net/npm/qabot@0.4"></script>
<script>
// This prevents the global search from interfering with qa-bot's internal text input.
document.addEventListener('DOMContentLoaded', () => {
document.querySelectorAll('qa-bot').forEach((x) => {
x.addEventListener('keydown', (event) => {
event.stopPropagation();
});
});
});
</script>
<qa-bot
server="https://tiangolo-sqlmodel.docsqa.jina.ai"
theme="infer"
title="SQLModel Bot"
description="SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness."
style="font-size: 0.8rem"
>
<template>
<dl>
<dt>You can ask questions about SQLModel. Try:</dt>
<dd>Which Python version is supported?</dd>
<dd>How SQLModel interacts with the database?</dd>
<dd>How can I link tables?</dd>
</dl>
</template>
</qa-bot>
{%- endblock %}

View File

@ -3,6 +3,7 @@ site_description: SQLModel, SQL databases in Python, designed for simplicity, co
site_url: https://sqlmodel.tiangolo.com/
theme:
name: material
custom_dir: docs/overrides
palette:
- scheme: default
primary: deep purple