How to enable footnote in ex_doc

I want to use ExDoc as the static site generater, but I do not know how to enable the footnote in the
mix.exs

Do anybody know how to do this?

Now my mix.exs define the project/0 like this:

def project do
    [
      app: :name,
      version: "0.1.0",
      elixir: "~> 1.13",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      docs: [
        formatters: ["html"],
        authors: ["Keep Zen"],
        api_reference: false,
        assets: "assets",
        before_closing_head_tag: &before_closing_head_tag/1,
        markdown_processor: {ErmarkParser, footnotes: true},
        extras: [
          "ch1.md",
          "ch2.md",
        ]
      ]
    ]
  end

And I get a error, say:

** (UndefinedFunctionError) function EarmarkParser.to_ast/2 is undefined or private

Might be a copy paste error, but this looks like a typo.

Thanks. Yes, you are right, this is typo. shoud be EarmarkParser.
The code is typed, but the error message is copyed.

I know how to do it:

def project do
    [
      app: :the_corner_of_elixir,
      version: "0.1.0",
      elixir: "~> 1.13",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      docs: [
        formatters: ["html"],
        authors: ["Keep Zen"],
        api_reference: false,
        assets: "assets",
        before_closing_head_tag: &before_closing_head_tag/1,
        markdown_processor: {ExDoc.Markdown.Earmark, footnotes: true},
        extras: [
          "ch1.md",
          "ch2.md"
        ]
      ]
    ]
  end

markdown_processor: {ExDoc.Markdown.Earmark, footnotes: true}
The module should be ExDoc.Markdown.Earmark not EarmarkParser.

1 Like