diff --git a/README.md b/README.md index 7e796ad8..3e47d4ee 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ developers in mind. + + ## Introduction This project serves as a functional RAG UI for both end users who want to do QA on their @@ -355,6 +357,8 @@ This file provides another way to configure your models and credentials. > (more instruction WIP). + + ## Star History diff --git a/doc_env_reqs.txt b/doc_env_reqs.txt index 48a321f1..ba7546d9 100644 --- a/doc_env_reqs.txt +++ b/doc_env_reqs.txt @@ -3,7 +3,7 @@ mkdocstrings[python] mkdocs-material mkdocs-gen-files mkdocs-literate-nav -mkdocs-video mkdocs-git-revision-date-localized-plugin mkdocs-section-index +mkdocs-include-markdown-plugin[cache] mdx_truly_sane_lists diff --git a/docs/development/index.md b/docs/development/index.md index 612c7a5e..5c48712d 100644 --- a/docs/development/index.md +++ b/docs/development/index.md @@ -1 +1,5 @@ ---8<-- "README.md" +{% + include-markdown "../../README.md" + start="" + end="" +%} diff --git a/mkdocs.yml b/mkdocs.yml index d04ff273..2849b37e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -80,6 +80,7 @@ plugins: fallback_to_build_date: true - section-index - mkdocs-video + - include-markdown theme: features: