Skip to content

🚧 POC: A lightweight toolkit for publishing Markdown blogs anywhere. Convert and style posts with ease, add custom themes, and streamline cross-posting from platforms like Dev.to to other communities.

License

Notifications You must be signed in to change notification settings

ChecKMarKDevTools/markdown-publisher-toolkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

19 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Markdown Publisher Toolkit

Convert dev.to articles to optimized HTML with SEO, accessibility, and inline CSS processing.

Badges

License Polyform Shield 1.0.0 Badge React Badge Vite Badge MUI Badge remark Badge Vitest Badge

Dev Dependencies

TypeScript Badge ESLint Prettier CSpell Badge Playwright Commitlint Conventional Commits Badge Lefthook


Features ✨

  • Dev Community Integration - Fetch articles directly from dev.to API
  • Markdown Processing - Clean, semantic HTML conversion
  • SEO & Accessibility - Meta tags, ARIA labels, semantic structure
  • CSS Inlining - Platform-ready styling
  • Export Options - Copy to clipboard or download HTML

Quick Start πŸš€

Prerequisites: Node.js 18+ and modern browser

git clone https://github.com/your-username/markdown-publisher-toolkit.git
cd markdown-publisher-toolkit
npm install
npm run dev

Visit http://localhost:3000 to start converting articles.

How to Use πŸ“–

  1. Paste a dev.to article URL
  2. Click "Convert Article"
  3. Preview the result
  4. Copy or download the HTML

Supported URLs:

  • https://dev.to/username/article-title
  • https://dev.to/organization/article-title

πŸ§ͺ Testing

npm test            # Full test suite with coverage
npm run test:unit   # Unit tests only
npm run test:integration # Browser tests

Current Status: 85% minimum coverage maintained

Development πŸ› οΈ

Project Structure:

src/
β”œβ”€β”€ components/     # React UI components
β”œβ”€β”€ services/       # Business logic (API, processors)
β”œβ”€β”€ hooks/         # Custom React hooks
β”œβ”€β”€ types/         # TypeScript definitions
└── App.tsx        # Main application

Scripts:

npm run dev         # Development server
npm run build       # Production build
npm run lint        # Code linting
npm run format      # Code formatting

Contributing 🀝

  1. Install dependencies: npm install
  2. Install Playwright: npx playwright install
  3. Install git hooks: npx lefthook install
  4. Run tests: npm test

Requirements:

  • 85% test coverage minimum
  • TypeScript strict mode
  • ESLint + Prettier compliance
  • Conventional Commits format

License πŸ“„

Every project has to have a stack of fine print somewhere. Keep going, keep going, keep going... Here's mine, as painless as possible:

You know where the license is, but I'll sum it up: this is not open source (even though you can still do just about anything you want with it). As long as you're not turning it into the next big SaaS or selling subscriptions in the cloud, then have fun! Else, you've gotta ask me first.

Basically? This project's got boundaries. Be cool, don't try to sneak it into a product launch, and we'll get along just fine. 😘


Acknowledgments πŸ™

  • Coder Legion: For the inspirationβ€”and for letting me ask a million questions.
    • Seriously, Andrew had no idea what he was signing up for, but deserves a medal for surviving the process. πŸ…
  • Dev Community: For providing an excellent API, an even better platform, and the kind of dev crowd that makes all of this even remotely possible.
    • Without y'all, this project probably wouldn't exist in the first place.

The ones who had no idea they helped

...but this would've been impossible without them

  • Unified Ecosystem: For all the markdown magic under the hood. Seriously, your tools just work.
  • Verdent Team: For building the kind of platform that makes "just one more experiment" dangerously easy.

Contact πŸ“§

dev.to Badge LinkedIn Medium Reddit Badge YouTube BuyMeACoffee


πŸ›‘οΈ This project was created with the help of AI.

About

🚧 POC: A lightweight toolkit for publishing Markdown blogs anywhere. Convert and style posts with ease, add custom themes, and streamline cross-posting from platforms like Dev.to to other communities.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published