CTAN Comprehensive TeX Archive Network

Direc­tory graphics/awesomebox

README.md

Awe­some Boxes is all about draw­ing ad­mo­ni­tion blocks around text to in­form or alert your read­ers about some­thing par­tic­u­lar. The spe­cific aim of this pack­age is to use Fon­tAwe­some 5 icons to ease the il­lus­tra­tion of these blocks.

The idea of ad­mo­ni­tion blocks comes from the ones you can eas­ily do with Asci­iDoc.

For more de­tails, please re­fer to the awe­some­box.pdf doc­u­ment.

Re­quire­ments

The fol­low­ing pack­ages are re­quired (they should be al­ready in­cluded in your dis­tri­bu­tion):

  • array
  • fontawesome5
  • ifthen
  • xcolor
  • xparse

In­stal­la­tion

Down­load the awesomebox.sty file and put it in the same folder of the doc­u­ment your are com­pos­ing.

For sys­tem wide in­stal­la­tion, please re­fer to the doc­u­men­ta­tion of your dis­tri­bu­tion.

Com­pat­i­bil­ity

This repos­i­tory also hosts the pack­age awesomebox-compat, which de­pends on the fontawesome pack­age, in­stead of fontawesome5. Apart from that, it has the ex­act same fea­tures set.

This can be use­full for you if you want to use it with an old dis­tri­bu­tion, which does not em­bed fontawesome5 yet (like Over­leaf sys­tem). To use it, down­load the file awesomebox-compat.sty in this repos­i­tory, put it near your tex files and just re­place your \usepackage{awesomebox} in­struc­tion by \usepackage{awesomebox-compat}.

Be aware that icon names changes be­tween Fon­tAwe­some and Fon­tAwe­some5 and thus us­ing the com­pat­i­bil­ity pack­age may break your cur­rent files. Fon­tAwe­some also re­quires you to use XeLaTeX or Lua: you can­not use PDF with the com­pat­i­bil­ity pack­age.

Li­cense

Awe­some Box is re­leased un­der the WTFPL. A copy of this li­cense is dis­tributed in this pack­age.

Down­load the con­tents of this pack­age in one zip archive (57.1k).

awe­some­box – Draw ad­mo­ni­tion blocks in your doc­u­ments, il­lus­trated with Fon­tAwe­some icons

Awe­some Boxes is all about draw­ing ad­mo­ni­tion blocks around text to in­form or alert read­ers about some­thing par­tic­u­lar. The spe­cific aim of this pack­age is to use Fon­tAwe­some icons to ease the il­lus­tra­tion of these blocks.

The pack­age de­pends on fontawe­some5, xcolor, ar­ray and xparse.

Pack­ageawe­some­box
Home pagehttps://git.de­paris.io/la­tex-awe­some­box/about/
Re­pos­i­toryhttps://git.de­paris.io/la­tex-awe­some­box/
Ver­sion0.6
Li­censesFree li­cense not oth­er­wise listed
Copy­right2016–2019 Éti­enne Deparis
Main­tainerÉti­enne Deparis
Con­tained inTeX Live as awe­some­box
MiKTeX as awe­some­box
TopicsBox­ing
...
Guest Book Sitemap Contact Contact Author