{"id":31766263,"url":"https://github.com/ayokanmi-adejola/markdown-previewer","last_synced_at":"2025-10-10T00:30:37.700Z","repository":{"id":308992264,"uuid":"1005984778","full_name":"Ayokanmi-Adejola/Markdown-Previewer","owner":"Ayokanmi-Adejola","description":"A beautiful, real-time markdown previewer built with React, TypeScript, and Tailwind CSS. Features GitHub Flavored Markdown support, responsive design, and maximize/minimize panels","archived":false,"fork":false,"pushed_at":"2025-06-21T09:30:27.000Z","size":537,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-30T00:00:39.034Z","etag":null,"topics":["lucide-react","marked-js","react18","tailwind-css","typescript","vite"],"latest_commit_sha":null,"homepage":"https://markdown-previewer-eta-khaki.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ayokanmi-Adejola.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-21T08:21:30.000Z","updated_at":"2025-09-24T11:56:36.000Z","dependencies_parsed_at":"2025-08-09T05:51:03.916Z","dependency_job_id":"b310ef91-1180-42eb-870a-3b2b0b487ad3","html_url":"https://github.com/Ayokanmi-Adejola/Markdown-Previewer","commit_stats":null,"previous_names":["ayokanmi-adejola/markdown-previewer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Ayokanmi-Adejola/Markdown-Previewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ayokanmi-Adejola%2FMarkdown-Previewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ayokanmi-Adejola%2FMarkdown-Previewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ayokanmi-Adejola%2FMarkdown-Previewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ayokanmi-Adejola%2FMarkdown-Previewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ayokanmi-Adejola","download_url":"https://codeload.github.com/Ayokanmi-Adejola/Markdown-Previewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ayokanmi-Adejola%2FMarkdown-Previewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002362,"owners_count":26083356,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lucide-react","marked-js","react18","tailwind-css","typescript","vite"],"created_at":"2025-10-10T00:30:06.678Z","updated_at":"2025-10-10T00:30:37.674Z","avatar_url":"https://github.com/Ayokanmi-Adejola.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown Previewer\n\nA beautiful, real-time markdown previewer built with React, TypeScript, and Tailwind CSS.\n\n![Markdown Previewer Screenshot](./public/preview.png)\n\n## 🚀 Features\n\n- **Real-time Preview**: See your markdown rendered as HTML instantly as you type\n- **GitHub Flavored Markdown**: Full support for GFM syntax including tables, strikethrough, and task lists\n- **Responsive Design**: Works seamlessly on desktop, tablet, and mobile devices\n- **Maximize/Minimize Panels**: Focus on editing or previewing with full-screen modes\n- **Copy to Clipboard**: Easily copy your markdown content with one click\n- **Beautiful UI**: Modern dark theme with smooth animations and micro-interactions\n- **Line Break Support**: Carriage returns are rendered as `\u003cbr\u003e` elements (bonus feature)\n\n## 🛠️ Technologies Used\n\n- **React 18** - Modern React with hooks\n- **TypeScript** - Type-safe development\n- **Tailwind CSS** - Utility-first CSS framework\n- **Marked.js** - Fast markdown parser and compiler\n- **Lucide React** - Beautiful, customizable icons\n- **Vite** - Fast build tool and development server\n\n## 📋 FreeCodeCamp Requirements\n\nThis project satisfies all user stories for the FreeCodeCamp Markdown Previewer challenge:\n\n- ✅ **User Story #1**: Textarea element with `id=\"editor\"`\n- ✅ **User Story #2**: Element with `id=\"preview\"`\n- ✅ **User Story #3**: Real-time preview updates as you type\n- ✅ **User Story #4**: GitHub flavored markdown rendering\n- ✅ **User Story #5**: Default markdown with all required elements\n- ✅ **User Story #6**: Default markdown rendered on load\n- ✅ **Bonus**: Carriage returns rendered as line breaks\n\n## 🎯 Default Markdown Elements\n\nThe editor loads with sample markdown demonstrating:\n\n- **Headings** (H1, H2, H3)\n- **Links** with hover effects\n- **Inline code** with syntax highlighting\n- **Code blocks** with language-specific formatting\n- **Lists** (ordered and unordered with nesting)\n- **Blockquotes** with custom styling\n- **Images** with responsive design\n- **Bold and italic** text formatting\n- **Strikethrough** text\n- **Tables** with alternating row colors\n\n## 🚀 Getting Started\n\n### Prerequisites\n\n- Node.js (version 16 or higher)\n- npm or yarn package manager\n\n### Installation\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/yourusername/markdown-previewer.git\ncd markdown-previewer\n```\n\n2. Install dependencies:\n```bash\nnpm install\n```\n\n3. Start the development server:\n```bash\nnpm run dev\n```\n\n4. Open your browser and navigate to `http://localhost:5173`\n\n### Building for Production\n\n```bash\nnpm run build\n```\n\nThe built files will be in the `dist` directory.\n\n## 🎨 Design Features\n\n### Color Scheme\n- **Primary**: Slate-based dark theme\n- **Accents**: Blue for editor, Green for preview\n- **Syntax**: Pink for code, Yellow for headings\n\n### Typography\n- **Editor**: Monospace font for code editing\n- **Preview**: Optimized prose typography with proper line spacing\n\n### Animations\n- Smooth transitions between maximize/minimize states\n- Hover effects on interactive elements\n- Copy button feedback animation\n\n## 📱 Responsive Breakpoints\n\n- **Mobile**: Single column layout (\u003c 1024px)\n- **Desktop**: Side-by-side layout (≥ 1024px)\n- **Maximized**: Full-width single panel on all devices\n\n## 🔧 Configuration\n\n### Marked.js Options\n```javascript\nmarked.setOptions({\n  breaks: true,    // Enable line breaks\n  gfm: true,      // GitHub Flavored Markdown\n});\n```\n\n### Tailwind CSS\nCustom prose styling for enhanced markdown rendering with dark theme support.\n\n## 📄 Project Structure\n\n```\nsrc/\n├── App.tsx          # Main application component\n├── main.tsx         # React entry point\n├── index.css        # Global styles and Tailwind imports\n└── vite-env.d.ts    # Vite type definitions\n\npublic/\n└── vite.svg         # Vite logo\n\nconfig files:\n├── package.json     # Dependencies and scripts\n├── tailwind.config.js\n├── vite.config.ts\n└── tsconfig.json\n```\n\n## 🧪 Testing\n\nThis project includes the FreeCodeCamp test suite. The tests automatically run when you load the application and verify all user story requirements.\n\n## 🌟 Key Components\n\n### State Management\n- `markdown`: Current markdown content\n- `isEditorMaximized`: Editor panel state\n- `isPreviewMaximized`: Preview panel state\n- `copied`: Copy button feedback state\n\n### Core Functions\n- `handleMarkdownChange`: Updates markdown state\n- `copyToClipboard`: Copies content with user feedback\n- `getPreviewHTML`: Converts markdown to HTML\n\n## 🎯 Performance Optimizations\n\n- Efficient re-rendering with React hooks\n- Optimized bundle size with Vite\n- Smooth scrolling in preview panel\n- Debounced markdown parsing\n\n\n## 👨‍💻 Author\n\n**Ayokanmi Adejola**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayokanmi-adejola%2Fmarkdown-previewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fayokanmi-adejola%2Fmarkdown-previewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayokanmi-adejola%2Fmarkdown-previewer/lists"}