.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mojolicious::Plugin::AssetPack::Pipe::Favicon 3pm"
.TH Mojolicious::Plugin::AssetPack::Pipe::Favicon 3pm "2021-02-20" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mojolicious::Plugin::AssetPack::Pipe::Favicon \- Generate favicons
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "Application"
.IX Subsection "Application"
.Vb 3
\&  plugin AssetPack => {pipes => ["Favicon"]};
\&  app\->asset\->pipe("Favicon")\->api_key("fd27cc5654345678765434567876545678765556");
\&  app\->asset\->process("favicon.ico" => "images/favicon.png");
\&
\&  # Can also register variations of the favicon:
\&  app\->asset\->process("favicon.variant1.ico" => "images/favicon1.png");
\&  app\->asset\->process("favicon.variant2.ico" => "images/favicon2.png");
.Ve
.PP
Note that the topic must be either \*(L"favicon.ico\*(R" or \*(L"favicon.some_identifier.ico\*(R".
.PP
The input image file should be a 260x260 \s-1PNG\s0 file for optimal results.
.SS "Template"
.IX Subsection "Template"
.Vb 1
\&  %= asset "favicon.ico"
.Ve
.PP
The above template will expand to whatever \s-1HTML\s0 that
<http://realfavicongenerator.net> has generated, based on \*(L"design\*(R". Example:
.PP
.Vb 6
\&  <link rel="icon" type="image/png" href="/asset/52eaz7613a/favicon\-16x16.png" sizes="16x16">
\&  <link rel="icon" type="image/png" href="/asset/65428718f1/favicon\-32x32.png" sizes="32x32">
\&  <link rel="apple\-touch\-icon" sizes="114x114" href="/asset/9aab8718f1/apple\-touch\-icon\-114x114.png">
\&  <link rel="apple\-touch\-icon" sizes="152x152" href="/asset/feee661542/apple\-touch\-icon\-152x152.png">
\&  <meta name="msapplication\-square310x310logo" content="/asset/123ab718f1/largelogo.png">
\&  <meta name="msapplication\-wide310x150logo" content="/asset/a827bfddf0/widelogo.png">
.Ve
.PP
By default this pipe will only create desktop icons. Configure \*(L"design\*(R" for
more icons.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mojolicious::Plugin::AssetPack::Pipe::Favicon uses
<http://realfavicongenerator.net> to generate all the different favicons that
is required for your site.
.PP
This pipe is \s-1EXPERIMENTAL.\s0 Let me know if you are using it.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "api_key"
.IX Subsection "api_key"
.Vb 2
\&  $self = $self\->api_key($key);
\&  $str = $self\->api_key;
.Ve
.PP
An \s-1API\s0 key obtained from <http://realfavicongenerator.net/api/>.
.SS "design"
.IX Subsection "design"
.Vb 2
\&  $hash = $self\->design;
\&  $self = $self\->design({desktop_browser => {}, ios => {}, windows => {}});
.Ve
.PP
Can be used to customize the different designs. Look for \*(L"favicon_design\*(R" on
<http://realfavicongenerator.net/api/non_interactive_api> for details.
.SS "settings"
.IX Subsection "settings"
.Vb 2
\&  $hash = $self\->settings;
\&  $self = $self\->settings({compression => 3});
.Ve
.PP
Can be used to customize the different settings. Look for \*(L"settings\*(R" on
<http://realfavicongenerator.net/api/non_interactive_api> for details.
.SH "METHODS"
.IX Header "METHODS"
.SS "process"
.IX Subsection "process"
See \*(L"process\*(R" in Mojolicious::Plugin::AssetPack::Pipe.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://realfavicongenerator.net>.
.PP
<https://css\-tricks.com/favicon\-quiz/>.
.PP
Mojolicious::Plugin::AssetPack.