Skip to content

Gitesh08/conspectus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Conspectus

A powerful Chrome extension that leverages built-in AI to convert descriptions into beautiful diagrams directly in your browser!

✨ Features

  • 🤖 Uses Chrome's built-in AI to understand diagram requirements
  • 📊 Generates various diagram types:
    • Flowcharts
    • Sequence diagrams
    • Class diagrams
    • State diagrams
    • Entity Relationship diagrams
  • 🎯 Simple, intuitive interface
  • ⚡ Real-time diagram generation
  • 🎨 Clean, modern design
  • 📱 Responsive side panel interface

⚠️ Before You Begin

Make sure you’re fully set up with Chrome’s AI capabilities by reviewing our quick Setup Guide.

🚀 Installation

Local Development Installation

  1. Clone this repository:
git clone https://github.com/Gitesh08/conspectus.git
  1. Open Chrome and navigate to:
chrome://extensions/
  1. Enable "Developer mode" in the top right corner.

  2. Click "Load unpacked" and select the extension directory.

🛠️ Project Structure

mermaid-diagram-generator/
├── manifest.json
├── background.js
├── images/
│   ├── icon16.png
│   ├── icon32.png
│   ├── icon48.png
│   └── icon128.png
├── lib/
│   └── mermaid.min.js
└── sidepanel/
    ├── index.html
    ├── styles.css
    └── script.js

💡 Usage

  1. Click the extension icon in your Chrome toolbar
  2. The side panel will open with the diagram generator interface
  3. Type your diagram description in natural language
    • Example: "Create a flowchart showing user registration process"
    • Example: "Make a sequence diagram for checkout flow"
  4. Click "Generate Diagram"
  5. View your generated diagram in the panel
  6. Use the reset button to start over

🌟 Example Prompts

Create a flowchart for user authentication with login and signup options

Generate a sequence diagram showing how a payment processor handles transactions

Make a state diagram for a traffic light system

Draw an ER diagram for a basic e-commerce database

⚙️ Technical Details

  • Built with vanilla JavaScript
  • Uses Chrome's built-in AI API
  • Integrates Mermaid.js for diagram rendering
  • Follows Chrome Extension Manifest V3 guidelines
  • CSP-compliant implementation

📝 License

Distributed under the MIT License. See LICENSE for more information.

👏 Acknowledgments

  • Mermaid.js for diagram rendering
  • Chrome team for the built-in AI API

⭐ If you found this project helpful, please consider giving it a star!

Made with ❤️ by Gitesh

About

A powerful Chrome extension that leverages built-in AI to convert descriptions into beautiful diagrams directly in your browser.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors