22c0dd5b2d
* Update docs * fix: add cognee colors and logo * fix: add link to community discord --------- Co-authored-by: Boris Arzentar <borisarzentar@gmail.com>
158 lines
3.8 KiB
YAML
158 lines
3.8 KiB
YAML
site_name: cognee
|
|
site_author: Vasilije Markovic
|
|
site_description: desc
|
|
repo_name: cognee
|
|
repo_url: https://github.com/topoteretes/cognee
|
|
site_url: https://www.congee.ai
|
|
edit_uri: edit/main/docs/
|
|
copyright: Copyright © 2024 cognee
|
|
theme:
|
|
name: material
|
|
logo: assets/logo.png
|
|
favicon: assets/favicon.png
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
edit: material/pencil
|
|
view: material/eye
|
|
theme:
|
|
admonition:
|
|
note: octicons/tag-16
|
|
abstract: octicons/checklist-16
|
|
info: octicons/info-16
|
|
tip: octicons/squirrel-16
|
|
success: octicons/check-16
|
|
question: octicons/question-16
|
|
warning: octicons/alert-16
|
|
failure: octicons/x-circle-16
|
|
danger: octicons/zap-16
|
|
bug: octicons/bug-16
|
|
example: octicons/beaker-16
|
|
quote: octicons/quote-16
|
|
features:
|
|
- announce.dismiss
|
|
- content.action.edit
|
|
- content.action.view
|
|
- content.code.annotate
|
|
- content.code.copy
|
|
- content.code.select
|
|
- content.tabs.link
|
|
- content.tooltips
|
|
- header.autohide
|
|
- navigation.expand
|
|
- navigation.footer
|
|
- navigation.indexes
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.instant.progress
|
|
- navigation.prune
|
|
- navigation.sections
|
|
- navigation.tabs
|
|
- navigation.top
|
|
- navigation.tracking
|
|
- navigation.path
|
|
- search.highlight
|
|
- search.share
|
|
- search.suggest
|
|
- toc.follow
|
|
# - toc.integrate
|
|
palette:
|
|
- scheme: cognee
|
|
primary: custom
|
|
font:
|
|
text: Roboto
|
|
code: Roboto Mono
|
|
custom_dir: docs/overrides
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
# Extensions
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- pymdownx.details
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.magiclink:
|
|
normalize_issue_symbols: true
|
|
repo_url_shorthand: true
|
|
user: tricalt
|
|
repo: cognee
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets:
|
|
auto_append:
|
|
- includes/mkdocs.md
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
combine_header_slug: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
nav:
|
|
- Overview:
|
|
- Overview: 'index.md'
|
|
- Start here:
|
|
- Installation: 'quickstart.md'
|
|
- Add data: 'data_ingestion.md'
|
|
- Create LLM enriched data store: 'templates.md'
|
|
- Explore data: 'search.md'
|
|
# - SDK:
|
|
# - Overview: 'sdk_overview.md'
|
|
- Configuration: 'configuration.md'
|
|
- What is cognee:
|
|
- Introduction: 'conceptual_overview.md'
|
|
- API reference: 'api_reference.md'
|
|
- Blog:
|
|
- "blog/index.md"
|
|
|
|
|
|
plugins:
|
|
- mkdocs-jupyter:
|
|
ignore_h1_titles: true
|
|
execute: false
|
|
- social
|
|
- search:
|
|
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
|
|
- minify:
|
|
minify_html: true
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
options:
|
|
members_order: alphabetical
|
|
allow_inspection: true
|
|
show_bases: true
|
|
- blog:
|
|
enabled: !ENV CI
|
|
blog_dir: "blog"
|
|
blog_toc: true
|
|
post_dir: blog/posts
|
|
post_date_format: yyyy/MM/dd
|
|
post_url_format: "{date}/{slug}"
|
|
authors_file: "{blog}/.authors.yml"
|
|
|
|
|