{"id":32004455,"url":"https://github.com/agoodway/html2markdown","last_synced_at":"2025-10-15T17:39:21.890Z","repository":{"id":245252652,"uuid":"817977140","full_name":"agoodway/html2markdown","owner":"agoodway","description":"Convert HTML to Markdown with Elixir","archived":false,"fork":false,"pushed_at":"2025-09-12T09:34:50.000Z","size":124,"stargazers_count":33,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-12T14:26:43.010Z","etag":null,"topics":["elixir","html","html2markdown","markdown","rag"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/agoodway.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-06-20T21:06:30.000Z","updated_at":"2025-10-06T19:15:18.000Z","dependencies_parsed_at":"2024-06-20T23:02:18.839Z","dependency_job_id":"a47972d8-37cc-4261-809d-78b00f395bcf","html_url":"https://github.com/agoodway/html2markdown","commit_stats":null,"previous_names":["cpursley/html2markdown"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/agoodway/html2markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agoodway%2Fhtml2markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agoodway%2Fhtml2markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agoodway%2Fhtml2markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agoodway%2Fhtml2markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agoodway","download_url":"https://codeload.github.com/agoodway/html2markdown/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agoodway%2Fhtml2markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279096659,"owners_count":26102622,"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-15T02:00:07.814Z","response_time":56,"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":["elixir","html","html2markdown","markdown","rag"],"created_at":"2025-10-15T17:39:18.170Z","updated_at":"2025-10-15T17:39:21.884Z","avatar_url":"https://github.com/agoodway.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Html2Markdown\n\n[![Hex.pm](https://img.shields.io/hexpm/v/html2markdown.svg)](https://hex.pm/packages/html2markdown)\n[![Hex Docs](https://img.shields.io/badge/hex-docs-purple.svg)](https://hexdocs.pm/html2markdown)\n[![License](https://img.shields.io/hexpm/l/html2markdown.svg)](https://github.com/cpursley/html2markdown/blob/main/LICENSE)\n[![CI](https://github.com/agoodway/html2markdown/workflows/CI/badge.svg)](https://github.com/agoodway/html2markdown/actions/workflows/ci.yml)\n\nConvert HTML to clean, readable Markdown. Designed for content extraction, this library handles common HTML patterns while filtering out non-content elements like navigation and and scripts.\n\n## Installation\n\nAdd `html2markdown` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:html2markdown, \"~\u003e 0.3.1\"}\n  ]\nend\n```\n\n## Quick Start\n\n```elixir\n# Basic conversion\nHtml2Markdown.convert(\"\u003ch1\u003eHello World\u003c/h1\u003e\u003cp\u003eWelcome to \u003cstrong\u003eElixir\u003c/strong\u003e!\u003c/p\u003e\")\n# =\u003e \"\\n# Hello World\\n\\n\\n\\nWelcome to **Elixir**!\\n\"\n\n# With custom options\nHtml2Markdown.convert(html, %{\n  navigation_classes: [\"nav\", \"menu\", \"custom-nav\"],\n  normalize_whitespace: true\n})\n```\n\n## Features\n\n- **Smart Content Extraction**: Automatically removes navigation, ads, and other non-content elements\n- **HTML5 Support**: Handles modern semantic elements like `\u003cdetails\u003e`, `\u003cmark\u003e`, `\u003ctime\u003e`\n- **Table Conversion**: Converts HTML tables to clean Markdown tables\n- **Entity Handling**: Properly decodes HTML entities (`\u0026amp;`, `\u0026lt;`, `\u0026nbsp;`, etc.)\n- **Configurable**: Customize filtering and processing behavior\n\n## Configuration Options\n\n```elixir\nHtml2Markdown.convert(html, %{\n  # CSS classes that identify navigation elements to remove\n  navigation_classes: [\"footer\", \"menu\", \"nav\", \"sidebar\", \"aside\"],\n  \n  # HTML tags to filter out during conversion\n  non_content_tags: [\"script\", \"style\", \"form\", \"nav\", ...],\n  \n  # Markdown flavor (currently :basic, future: :gfm, :commonmark)\n  markdown_flavor: :basic,\n  \n  # Normalize whitespace (collapses multiple spaces, trims)\n  normalize_whitespace: true\n})\n```\n\n## Common Use Cases\n\n### Web Scraping\nExtract readable content from web pages:\n\n```elixir\n{:ok, %{body: html}} = Req.get!(url)\nmarkdown = Html2Markdown.convert(html)\n```\n\n### Content Migration\nConvert existing HTML content to Markdown:\n\n```elixir\n# Convert blog posts from HTML to Markdown\nhtml_content\n|\u003e Html2Markdown.convert(%{normalize_whitespace: true})\n|\u003e save_as_markdown()\n```\n\n### Email Processing\nClean up HTML emails for plain text storage:\n\n```elixir\nemail_html\n|\u003e Html2Markdown.convert(%{\n  non_content_tags: [\"style\", \"script\", \"meta\"],\n  navigation_classes: [\"unsubscribe\", \"footer\"]\n})\n```\n\n## Supported Elements\n\n- **Headings**: `\u003ch1\u003e` through `\u003ch6\u003e`\n- **Text**: Paragraphs, emphasis (`\u003cem\u003e`, `\u003ci\u003e`), strong (`\u003cstrong\u003e`, `\u003cb\u003e`)\n- **Lists**: Ordered and unordered lists with nesting\n- **Links**: `\u003ca\u003e` tags with proper URL handling\n- **Images**: `\u003cimg\u003e` and `\u003cpicture\u003e` elements\n- **Code**: Both inline `\u003ccode\u003e` and block `\u003cpre\u003e` elements\n- **Tables**: Full table support with headers\n- **Quotes**: `\u003cblockquote\u003e` and `\u003cq\u003e` elements\n- **HTML5**: `\u003cdetails\u003e`, `\u003csummary\u003e`, `\u003cmark\u003e`, `\u003cabbr\u003e`, `\u003ccite\u003e`, `\u003ctime\u003e`, `\u003cvideo\u003e`\n\n## Documentation\n\nFull documentation is available at [https://hexdocs.pm/html2markdown](https://hexdocs.pm/html2markdown).\n\n## Development\n\nThis project includes comprehensive testing and quality assurance tools:\n\n### Running Tests\n```bash\n# Run all tests\nmix test\n\n# Run tests with coverage\nmix coveralls.html\n```\n\n### Code Quality\n```bash\n# Run all quality checks (formatting, security, linting)\nmix quality\n\n# Individual checks\nmix format --check-formatted  # Code formatting\nmix credo --only warning       # Code linting\nmix sobelow --config          # Security analysis\n```\n\n### CI/CD\nThis project uses GitHub Actions for continuous integration with:\n- Multi-version testing (Elixir 1.15-1.17, OTP 25-27)\n- Code quality enforcement\n- Security scanning\n- Test coverage reporting\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoodway%2Fhtml2markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoodway%2Fhtml2markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoodway%2Fhtml2markdown/lists"}