diff --git a/.gitignore b/.gitignore index b403da38..6e247f49 100644 --- a/.gitignore +++ b/.gitignore @@ -8,5 +8,9 @@ __pycache__/ llmware.egg-info/ venv/ +# Jekyll +docs/_site/ + + # Mac .DS_Store/ diff --git a/docs/_includes/footer_custom.html b/docs/_includes/footer_custom.html new file mode 100644 index 00000000..2d56178d --- /dev/null +++ b/docs/_includes/footer_custom.html @@ -0,0 +1,33 @@ + + +

+ © 2023-{{ "now" | date: "%Y" }} AI Bloks +

diff --git a/docs/_includes/head_custom.html b/docs/_includes/head_custom.html new file mode 100644 index 00000000..cd6a6734 --- /dev/null +++ b/docs/_includes/head_custom.html @@ -0,0 +1,57 @@ + + + + diff --git a/docs/assets/images/hf-logo.svg b/docs/assets/images/hf-logo.svg new file mode 100644 index 00000000..ab959d16 --- /dev/null +++ b/docs/assets/images/hf-logo.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/assets/images/llmware_logo_color_cropped.png b/docs/assets/images/llmware_logo_color_cropped.png new file mode 100644 index 00000000..a618d5bd Binary files /dev/null and b/docs/assets/images/llmware_logo_color_cropped.png differ diff --git a/docs/index.md b/docs/index.md index 6df20842..2c492a89 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,12 @@ nav_order: 1 description: llmware is an integrated framework with over 50+ models in Hugging Face for quickly developing LLM-based applications including Retrieval Augmented Generation (RAG) and Multi-Step Orchestration of Agent Workflows. permalink: / --- -# Welcome to llmware +# Welcome to + `llmware` is an integrated framework with over 50+ models in Hugging Face for quickly developing LLM-based applications including Retrieval Augmented Generation (RAG) and Multi-Step Orchestration of Agent Workflows. {: .fs-6 .fw-300 } @@ -14,6 +19,28 @@ permalink: / [View llmware on GitHub](https://github.com/llmware-ai/llmware/tree/main){: .btn .fs-5 .mb-4 .mb-md-0 } [Open an Issue on GitHub](https://github.com/llmware-ai/llmware/issues){: .btn .fs-5 .mb-4 .mb-md-0 } +--- + +--- # Install llmware @@ -46,4 +73,4 @@ ModelCatalog().tool_test_run("slim-sentiment-tool") ## License -`llmware` is diributed by an [Apache-2.0 license](https://github.com/llmware-ai/llmware/blob/main/LICENSE). +`llmware` is distributed by an [Apache-2.0 license](https://github.com/llmware-ai/llmware/blob/main/LICENSE).