Skip to content

1st argument: not an iodata term error when ex_doc wants to convert my README #2128

Closed
@shahryarjb

Description

@shahryarjb

Hi, my last version was 0.37.3 and I updated to 0.38.1. but it can not be able to convert my README ad doc.
I have no problem in 0.37.3

Example README.md file: https://github.com/mishka-group/mishka_chelekom/blob/master/README.md

Error

mishka_chelekom git:(master) ✗ mix docs
Generating docs...
** (ArgumentError) errors were found at the given arguments:

  * 1st argument: not an iodata term

    :erlang.iolist_to_binary([["<p align=\"center\">", ["\n![Screenshot 2024-10-05 at 01 53 03](https://github.com/user-attachments/assets/16860771-e9e8-43f5-8441-d16ad8793ae6)\n"], "</p>"], ["<p align=\"center\">", ["  <a href=\"https://github.com/mishka-group/mishka_chelekom/blob/master/LICENSE\">\n    <img alt=\"License\" src=\"https://img.shields.io/github/license/mishka-group/mishka_chelekom\">\n  </a>\n\n  <a href=\"https://hex.pm/packages/mishka_chelekom\">\n      <img alt=\"Releases\" src=\"https://img.shields.io/hexpm/v/mishka_chelekom.svg\">\n  </a>\n\n  <a href=\"https://hex.pm/packages/mishka_chelekom\">\n      <img alt=\"Hex.pm Downloads\" src=\"https://img.shields.io/hexpm/dt/mishka_chelekom\">\n  </a>\n\n  <a href=\"https://github.com/mishka-group/mishka_chelekom/releases\">\n    <img alt=\"GitHub release (with filter)\" src=\"https://img.shields.io/github/v/release/mishka-group/mishka_chelekom\">\n  </a>\n\n  <a href=\"#\">\n    <img alt=\"Code Size in Bytes\" src=\"https://img.shields.io/github/languages/code-size/mishka-group/mishka_chelekom\">\n  </a>\n\n  <a href=\"https://github.com/mishka-group/mishka_chelekom/issues\">\n    <img alt=\"Issues\" src=\"https://img.shields.io/github/issues/mishka-group/mishka_chelekom\">\n  </a>"], "</p>"], ["<h2 id=\"phoenix-phoenix-liveview-components-and-ui-kit-library\" align=\"center\" class=\"section-heading\">", [{:a, [href: "#phoenix-phoenix-liveview-components-and-ui-kit-library", class: "hover-link"], [{:i, [class: "ri-link-m", "aria-hidden": "true"], [], %{}}], %{}}, {:span, [class: "text"], ["Phoenix & Phoenix LiveView components and UI kit library"], %{}}], "</h2>"], ["<div align=\"center\">", ["  <pre style=\"display: inline-block; text-align: left;\">\n    💖 Hey there! If you like my work, please <b><a href=\"https://github.com/sponsors/mishka-group\">support me financially!</a></b> 💖\n  </pre>"], "</div>"], "<br/>", ["<p align=\"center\">", ["  <a href=\"https://www.buymeacoffee.com/mishkagroup\">\n    <img src=\"https://img.buymeacoffee.com/button-api/?text=Donate with Buy Me a Coffee&emoji=☕&slug=mishkagroup&button_colour=FFDD00&font_colour=000000&font_family=Bree&outline_colour=000000&coffee_colour=ffffff\" />\n  </a>"], "</p>"], ["<h2 id=\"why-you-should-use-mishka-chelekom-as-phoenix-component-library\" class=\"section-heading\">", [["<a href=\"#why-you-should-use-mishka-chelekom-as-phoenix-component-library\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Why you should use Mishka Chelekom as Phoenix component library"], "</span>"]], "</h2>"], ["<p>", [["<strong>", ["Mishka Chelekom"], "</strong>"], " is a powerful library designed to simplify the process of building UI components in ", ["<strong>", ["Phoenix"], "</strong>"], " and ", ["<strong>", ["Phoenix LiveView"], "</strong>"], " projects. Unlike other solutions, it generates fully customizable components directly into your project—no hidden dependencies, no complex configurations."], "</p>"], ["<p>", ["With our rich collection of ready-to-use components, comprehensive documentation, and numerous examples, you can easily tailor every element to fit your needs. All components are generated locally (by Our ", ["<code class=\"inline\">", ["mix"], "</code>"], " generator), giving you full control over the source code without being locked into any external library."], "</p>"], ["<div align=\"center\">", ["  <pre style=\"display: inline-block; text-align: left;\">\n      <strong>💼 All components are completely free and open-source.🥂</strong>\n      For <strong>Pro support</strong> and <strong>enterprise services</strong>, <a href=\"https://mishka.tools/chelekom/custom-service\">click here!</a> to get in touch with us.\n  </pre>"], "</div>"], ["<blockquote>", [["<p>", [["<strong>", ["Mishka Chelekom"], "</strong>"], " is a library offering various templates for components in ", ["<strong>", ["Phoenix"], "</strong>"], " and ", ["<strong>", ["Phoenix LiveView"], "</strong>"], " - ", ["<a href=\"https://mishka.tools/chelekom\">", ["Phoenix UI kit and components"], "</a>"], "."], "</p>"], ["<p>", ["This means you can generate any component listed in this project using a ", ["<code class=\"inline\">", ["CLI"], "</code>"], " command with customizable options."], "</p>"], ["<p>", ["For example, you can create a component with an ", ["<code class=\"inline\">", ["info"], "</code>"], " color and a &quot;shadow&quot; variant without having any unnecessary code clutter."], "</p>"]], "</blockquote>"], ["<p>", ["If you want to add another variant in the future, the project is powered by the ", ["<a href=\"https://github.com/ash-project/igniter\">", [["<strong>", ["Igniter"], "</strong>"]], "</a>"], " library, which makes it easy to update the previous code seamlessly."], "</p>"], ["<p>", ["You will only use this library in your ", ["<code class=\"inline\">", ["development"], "</code>"], " environment, and it will not have any presence in production."], "</p>"], ["<h2 id=\"installation\" class=\"section-heading\">", [["<a href=\"#installation\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Installation"], "</span>"]], "</h2>"], ["<pre>", [["<code class=\"makeup elixir\" translate=\"no\">", ["<span class=\"kd\">def</span><span class=\"w\"> </span><span class=\"nf\">deps</span><span class=\"w\"> </span><span class=\"k\" data-group-id=\"3787156091-1\">do</span><span class=\"w\">\n  </span><span class=\"p\" data-group-id=\"3787156091-2\">[</span><span class=\"w\">\n    </span><span class=\"p\" data-group-id=\"3787156091-3\">{</span><span class=\"ss\">:mishka_chelekom</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"s\">&quot;~&gt; 0.0.5&quot;</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"ss\">only</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"ss\">:dev</span><span class=\"p\" data-group-id=\"3787156091-3\">}</span><span class=\"w\">\n  </span><span class=\"p\" data-group-id=\"3787156091-2\">]</span><span class=\"w\">\n</span><span class=\"k\" data-group-id=\"3787156091-1\">end</span>"], "</code>"]], "</pre>"], ["<p>", ["Generate all components inside the ", ["<code class=\"inline\">", ["components"], "</code>"], " directory of your Phoenix project."], "</p>"], ["<h3 id=\"creating-a-component-example-creating-an-alert\" class=\"section-heading\">", [["<a href=\"#creating-a-component-example-creating-an-alert\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Creating a Component (Example: Creating an Alert)"], "</span>"]], "</h3>"], ["<pre>", [["<code class=\"makeup bash\" translate=\"no\">", ["<span class=\"\">mix mishka.ui.gen.component alert --color info --variant default\n</span><span class=\"\">mix mishka.ui.gen.component alert\n</span><span class=\"\"># For Windows users please use `&quot;&quot;` when you have more than\n</span><span class=\"\"># one value for an argument\n</span><span class=\"\">mix mishka.ui.gen.component alert --color &quot;info,danger&quot;\n</span>"], "</code>"]], "</pre>"], ["<h3 id=\"generating-all-components\" class=\"section-heading\">", [["<a href=\"#generating-all-components\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Generating All Components"], "</span>"]], "</h3>"], ["<pre>", [["<code class=\"makeup bash\" translate=\"no\">", ["<span class=\"\">mix mishka.ui.gen.components\n</span><span class=\"\">mix mishka.ui.gen.components alert,accordion,chat\n</span>"], "</code>"]], "</pre>"], ["<h3 id=\"generating-all-components-with-an-import-file\" class=\"section-heading\">", [["<a href=\"#generating-all-components-with-an-import-file\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Generating All Components with an Import File"], "</span>"]], "</h3>"], ["<pre>", [["<code class=\"makeup bash\" translate=\"no\">", ["<span class=\"\">mix mishka.ui.gen.components --import --yes\n</span><span class=\"\">mix mishka.ui.gen.components alert,accordion,chat --import --yes\n</span>"], "</code>"]], "</pre>"], ["<blockquote>", [["<p>", ["This command creates all the components along with a file where all the components are imported."], "</p>"]], "</blockquote>"], ["<h3 id=\"generating-all-components-using-an-import-file-with-helper-functions\" class=\"section-heading\">", [["<a href=\"#generating-all-components-using-an-import-file-with-helper-functions\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Generating All Components Using an Import File with Helper Functions"], "</span>"]], "</h3>"], ["<pre>", [["<code class=\"makeup bash\" translate=\"no\">", ["<span class=\"\"># Install all components along with helper functions and macros for importing\n</span><span class=\"\">mix mishka.ui.gen.components --import --helpers --yes\n</span><span class=\"\">mix mishka.ui.gen.components alert,accordion,chat --import --helpers --yes\n</span><span class=\"\">\n</span><span class=\"\"># Install all components with helper functions and macros for importing,\n</span><span class=\"\"># and globally replace them with Phoenix core components (**Recommended**)\n</span><span class=\"\">mix mishka.ui.gen.components --import --helpers --global --yes\n</span><span class=\"\">\n</span><span class=\"\"># Alternatively, if your project includes Igniter and\n</span><span class=\"\"># you are using the latest alpha version, you can run:\n</span><span class=\"\">mix igniter.new my_app --with phx.new --install mishka_chelekom\n</span>"], "</code>"]], "</pre>"], ["<details>", ["  <summary>All options</summary>\n\n\n  ## Options `mishka.ui.gen.component` task\n\n  * `--variant` or `-v` - Specifies component variant\n  * `--color` or `-c` - Specifies component color\n  * `--size` or `-s` - Specifies component size\n  * `--padding` or `-p` - Specifies component padding\n  * `--space` or `-sp` - Specifies component space\n  * `--type` or `-t` - Specifies component type\n  * `--rounded` or `-r` - Specifies component type\n  * `--no-sub-config` - Creates dependent components with default settings\n  * `--module` or `-m` - Specifies a custom name for the component module\n  * `--sub` - Specifies this task is a sub task\n  * `--no-deps` - Specifies this task is created without sub task\n  * `--yes` - Makes directly without questions\n\n  ## Options `mishka.ui.gen.components` task\n\n  * `--import` - Generates import file\n  * `--helpers` - Specifies helper functions of each component in import file\n  * `--global` - Makes components accessible throughout the project without explicit imports\n  * `--yes` - Makes directly without questions\n\n  ## Options `mishka.ui.add` task\n\n  * `--no-github` - Specifies a URL without github replacing\n  * `--headers` - Specifies a repo url request headers\n\n  ---\n"], "</details>"], "<hr class=\"thin\"/>", ["<h3 id=\"optimized-for-minimal-dependencies\" class=\"section-heading\">", [["<a href=\"#optimized-for-minimal-dependencies\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Optimized for Minimal Dependencies"], "</span>"]], "</h3>"], ["<p>", ["This project ensures optimal performance by minimizing dependencies and leveraging the advanced features of ", ["<strong>", ["Tailwind CSS"], "</strong>"], "."], "</p>"], ["<h3 id=\"links\" class=\"section-heading\">", [["<a href=\"#links\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Links:"], "</span>"]], "</h3>"], ["<ul>", [["<li>", ["Project Page: ", ["<a href=\"https://mishka.tools/chelekom\">", ["https://mishka.tools/chelekom"], "</a>"]], "</li>"], ["<li>", ["Project Documentation: ", ["<a href=\"https://mishka.tools/chelekom/docs\">", ["https://mishka.tools/chelekom/docs"], "</a>"]], "</li>"], ["<li>", ["Created components list: ", ["<a href=\"https://github.com/mishka-group/mishka_chelekom/tree/master/priv/components\">", ["Heex file and configs"], "</a>"]], "</li>"], ["<li>", ["Hex.pm: ", ["<a href=\"https://hex.pm/packages/mishka_chelekom\">", ["https://hex.pm/packages/mishka_chelekom"], "</a>"]], "</li>"]], "</ul>"], "<hr class=\"thin\"/>", ["<h3 id=\"our-stacks\" class=\"section-heading\">", [["<a href=\"#our-stacks\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["Our stacks:"], "</span>"]], "</h3>"], ["<ol>", [["<li>", [["<a href=\"https://github.com/elixir-lang/elixir\">", ["Elixir"], "</a>"]], "</li>"], ["<li>", [["<a href=\"https://github.com/phoenixframework/phoenix\">", ["Phoenix"], "</a>"]], "</li>"], ["<li>", [["<a href=\"https://github.com/phoenixframework/phoenix_live_view\">", ["Phoenix LiveView"], "</a>"]], "</li>"], ["<li>", [["<a href=\"https://github.com/tailwindlabs/tailwindcss\">", ["Tailwind CSS"], "</a>"]], "</li>"], ["<li>", ["Pure JavaScript"], "</li>"]], "</ol>"], "<hr class=\"thin\"/>", ["<h3 id=\"faq\" class=\"section-heading\">", [["<a href=\"#faq\" class=\"hover-link\">", [["<i class=\"ri-link-m\" aria-hidden=\"true\">", [], "</i>"]], "</a>"], ["<span class=\"text\">", ["FAQ"], "</span>"]], "</h3>"], ["<ul>", [["<li>", ["Do I need any config or external project?"], "</li>"]], "</ul>"], ["<blockquote>", [["<p>", ["The Chelekom library is fully zero-configuration, meaning you don't need to install anything other than the library itself"], "</p>"]], "</blockquote>"], ["<ul>", [["<li>", ["What does the generator do?"], "</li>"]], "</ul>"], ["<blockquote>", [["<p>", ["The generator does all the work for you, from building to updating and transferring the heex, ex files to your Phoenix project."], "</p>"]], "</blockquote>"], ["<ul>", [["<li>", ["What should be done for Phoenix umbrella projects?"], "</li>"]], "</ul>"], ["<blockquote>", [["<p>", ["Just go to the path of your desired Phoenix project and execute the required Mix commands there."], "</p>"]], "</blockquote>"], ["<ul>", [["<li>", ["How much will this project be updated?"], "</li>"]], "</ul>"], ["<blockquote>", [["<p>", ["In the initial versions, we managed to create more than 80 components for Phoenix and LiveView, and our goal is up to 200 components. After that, we are going to build complete templates as well as a very useful API for programmers."], "</p>"]], "</blockquote>"], ["<ul>", [["<li>", [...], ...]], "</ul>"], ["<blockquote>", [["<p>", ...]], "</blockquote>"], ["<ul>", [[...]], "</ul>"], ["<blockquote>", [...], ...], "<hr class=\"thin\"/>", [...], ...])
    (ex_doc 0.38.1) lib/ex_doc/doc_ast.ex:37: ExDoc.DocAST.to_string/1
    (ex_doc 0.38.1) lib/ex_doc/formatter/html/templates/extra_template.eex:32: ExDoc.Formatter.HTML.Templates.extra_template/3
    (ex_doc 0.38.1) lib/ex_doc/formatter/html.ex:222: anonymous fn/2 in ExDoc.Formatter.HTML.generate_extras/2
    (elixir 1.18.3) lib/enum.ex:1714: Enum."-map/2-lists^map/1-1-"/2
    (ex_doc 0.38.1) lib/ex_doc/formatter/html.ex:212: ExDoc.Formatter.HTML.generate_extras/2
    (ex_doc 0.38.1) lib/ex_doc/formatter/html.ex:39: ExDoc.Formatter.HTML.run/3
    (ex_doc 0.38.1) lib/mix/tasks/docs.ex:531: anonymous fn/6 in Mix.Tasks.Docs.run/3

Thank you in advance

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions