Files
ShadowArcanist 3322c34dc7 Added Dynamic OG image generation, Auto Collapse inactive folders and much more (#13)
* 🐛 Fixed a typo on readme

*  Added Dynamic OG image generation

> When sharing any links to our docs pages on social media
it won't show any OG image, it only shows title & description.

> I have fixed this OG image issue by adding Vercel's OG library
which auto-generates OG image based on the title of the page.

> This OG generation uses Vercel Edge runtime.

*  Added Auto-collapse inactive folders on sidebar

> We can open as many folders as we want on the left side of the screen.

> But if we open too many, it gets messy. We have to close them one by one.

> So, I have implemented an automatic collapse feature for inactive
folders, so that only one folder remains open at any given time.

*  Added 'Scroll to top' feature

> If a page on docs is too long then we have to manually
scroll to the to the top.

> So I have added a feature 'Scroll to top' on the right sidebar
below the option 'Edit this page'

*  Added Overview page for AnythingLLM cloud

> Added a Overview page

> Updated the img directory for anythingllm cloud thumbnail and
updated the src links on the pages where the image is used.
2024-05-08 11:15:29 -07:00

1.6 KiB

AnythingLLM logo

Project Structure

├── public/
│   ├── images/
│   │   ├── anythingllm-setup/
│   │   ├── features/
│   │   ├── getting-started/
│   │   ├── guides-and-faq/
│   │   ├── home/
│   │   ├── legal/
│   │   └── product/
│   ├── favicon.png
│   ├── licence.txt
│   └── robots.txt
├── pages/
│   ├── anythingllm-setup/
│   ├── features/
│   ├── getting-started/
│   ├── guides-and-faq/
│   ├── legal/
│   ├── product/
│   ├── anythingllm-cloud.mdx
│   ├── contribute.mdx
│   └── index.mdx
├── components/
│   └── icons/
├── next-env.d.ts
├── next.config.js
├── package.json
├── pull-request-template.md
├── README.md
├── theme.config.tsx
└── tsconfig.json

Setup for Local Development

  1. Clone this Repository to your local machine using git clone:
git clone https://github.com/Mintplex-Labs/anythingllm-docs.git
  1. Install dependencies using yarn:
yarn
  1. Start the development server:
yarn dev

Contributing

  • Create issue
  • Create PR with branch name format of <issue number>-<short name>
  • yee haw let's merge

License

This project is licensed under the MIT License.

special thanks to @ShadowArcanist for the migration to NextJS