Skip to content

docs: add table of contents to README for easier navigation #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShaikHusnaThahera wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add table of contents to README for easier navigation #222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,28 @@

---

## 📑 Table of Contents

- [📖 What is LeetLog AI?](#-what-is-leetlog-ai)
- [✨ Features](#-features)
- [🏗️ Architecture](#️-architecture)
- [🚀 Getting Started](#-getting-started)
- [Prerequisites](#prerequisites)
- [1. Clone the Repository](#1-clone-the-repository)
- [2. Set Up the Backend](#2-set-up-the-backend)
- [3. Run the Reminder Queue](#3-run-the-reminder-queue)
- [4. Run the Web Dashboard](#4-run-the-web-dashboard)
- [5. Load the Chrome Extension](#5-load-the-chrome-extension)
- [6. Use It!](#6-use-it)
- [📁 Project Structure](#-project-structure)
- [🔮 Future Scope](#-future-scope-ideas-for-open-source-contributors)
- [🌐 Deploying the Backend](#-deploying-the-backend)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)
- [🙏 Acknowledgements](#-acknowledgements)

---

## 📖 What is LeetLog AI?

**LeetLog AI** is a Chrome Extension with a Python FastAPI backend that automatically generates and publishes technical blog posts whenever you solve a LeetCode problem.
Expand Down