diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 8cc9876..4a78c81 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -41,5 +41,5 @@ jobs: - name: Deploy GitHub Pages run: | - pip install mkdocs-material mdx-include termynal + pip install 'mkdocs-material[imaging]' mdx-include termynal 'mkdocstrings[python]' mkdocs gh-deploy --force diff --git a/README.md b/README.md index 9d4aa1e..a81b80d 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ [![Stars](https://img.shields.io/github/stars/ajndkr/lanarky)](https://github.com/ajndkr/lanarky/stargazers) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ajndkr/lanarky/blob/main/LICENSE) [![Twitter](https://img.shields.io/twitter/follow/LanarkyAPI?style=social)](https://twitter.com/intent/follow?screen_name=LanarkyAPI) +[![Discord](https://img.shields.io/badge/join-Discord-7289da.svg)](https://discord.gg/6qUfrQAEeE) [![Python](https://img.shields.io/pypi/pyversions/lanarky.svg)](https://pypi.org/project/lanarky/) [![Coverage](https://coveralls.io/repos/github/ajndkr/lanarky/badge.svg?branch=main)](https://coveralls.io/github/ajndkr/lanarky?branch=main) diff --git a/docs/getting-started.md b/docs/getting-started.md index 1d3348b..6b867f9 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,12 +1,14 @@ --- hide: - navigation + - footer --- Let's build our first LLM microservice with Lanarky! -We need to first install some extra dependencies as we will use OpenAI as the LLM -provider. +## Dependencies + +First, we will install Lanarky with the OpenAI adapter: diff --git a/docs/index.md b/docs/index.md index 64ac0b3..8c36ac6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,6 +2,7 @@ hide: - navigation - toc + - footer ---