index.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  7. <link rel="canonical" href="https://heydon.github.io/infusion/patterns/library-setup/">
  8. <link rel="apple-touch-icon" sizes="57x57" href="https://heydon.github.io/infusion/images/apple-icon-57x57.png">
  9. <link rel="apple-touch-icon" sizes="60x60" href="https://heydon.github.io/infusion/images/apple-icon-60x60.png">
  10. <link rel="apple-touch-icon" sizes="72x72" href="https://heydon.github.io/infusion/images/apple-icon-72x72.png">
  11. <link rel="apple-touch-icon" sizes="76x76" href="https://heydon.github.io/infusion/images/apple-icon-76x76.png">
  12. <link rel="apple-touch-icon" sizes="114x114" href="https://heydon.github.io/infusion/images/apple-icon-114x114.png">
  13. <link rel="apple-touch-icon" sizes="120x120" href="https://heydon.github.io/infusion/images/apple-icon-120x120.png">
  14. <link rel="apple-touch-icon" sizes="144x144" href="https://heydon.github.io/infusion/images/apple-icon-144x144.png">
  15. <link rel="apple-touch-icon" sizes="152x152" href="https://heydon.github.io/infusion/images/apple-icon-152x152.png">
  16. <link rel="apple-touch-icon" sizes="180x180" href="https://heydon.github.io/infusion/images/apple-icon-180x180.png">
  17. <link rel="icon" type="image/png" sizes="192x192" href="https://heydon.github.io/infusion/images/android-icon-192x192.png">
  18. <link rel="icon" type="image/png" sizes="32x32" href="https://heydon.github.io/infusion/images/favicon-32x32.png">
  19. <link rel="icon" type="image/png" sizes="96x96" href="https://heydon.github.io/infusion/images/favicon-96x96.png">
  20. <link rel="icon" type="image/png" sizes="16x16" href="https://heydon.github.io/infusion/images/favicon-16x16.png">
  21. <link rel="manifest" href="https://heydon.github.io/infusion/manifest.json">
  22. <meta name="msapplication-TileColor" content="#ffffff">
  23. <meta name="msapplication-TileImage" content="/images/ms-icon-144x144.png">
  24. <meta name="theme-color" content="#ffffff">
  25. <link rel="stylesheet" href="https://heydon.github.io/infusion/css/prism.css" />
  26. <link rel="stylesheet" type="text/css" href="https://heydon.github.io/infusion/css/styles.css">
  27. <script src="https://heydon.github.io/infusion/js/webcomponents.js"></script>
  28. <title>
  29. Library setup | Infusion
  30. </title>
  31. </head>
  32. <body>
  33. <a href="#main">skip to content</a>
  34. <svg style="display: none">
  35. <symbol id="bookmark" viewBox="0 0 40 50">
  36. <g transform="translate(2266 3206.2)">
  37. <path style="stroke:currentColor;stroke-width:3.2637;fill:none" d="m-2262.2-3203.4-.2331 42.195 16.319-16.318 16.318 16.318.2331-42.428z"/>
  38. </g>
  39. </symbol>
  40. <symbol id="w3c" viewBox="0 0 127.09899 67.763">
  41. <text font-size="83" style="font-size:83px;font-family:Trebuchet;letter-spacing:-12;fill-opacity:0" letter-spacing="-12" y="67.609352" x="-26.782778">W3C</text>
  42. <text font-size="83" style="font-size:83px;font-weight:bold;font-family:Trebuchet;fill-opacity:0" y="67.609352" x="153.21722" font-weight="bold">SVG</text>
  43. <path style="fill:#111111;image-rendering:optimizeQuality;shape-rendering:geometricPrecision" d="m33.695.377 12.062 41.016 12.067-41.016h8.731l-19.968 67.386h-.831l-12.48-41.759-12.479 41.759h-.832l-19.965-67.386h8.736l12.061 41.016 8.154-27.618-3.993-13.397h8.737z"/>
  44. <path style="fill:#111111;image-rendering:optimizeQuality;shape-rendering:geometricPrecision" d="m91.355 46.132c0 6.104-1.624 11.234-4.862 15.394-3.248 4.158-7.45 6.237-12.607 6.237-3.882 0-7.263-1.238-10.148-3.702-2.885-2.47-5.02-5.812-6.406-10.022l6.82-2.829c1.001 2.552 2.317 4.562 3.953 6.028 1.636 1.469 3.56 2.207 5.781 2.207 2.329 0 4.3-1.306 5.909-3.911 1.609-2.606 2.411-5.738 2.411-9.401 0-4.049-.861-7.179-2.582-9.399-1.995-2.604-5.129-3.912-9.397-3.912h-3.327v-3.991l11.646-20.133h-14.062l-3.911 6.655h-2.493v-14.976h32.441v4.075l-12.31 21.217c4.324 1.385 7.596 3.911 9.815 7.571 2.22 3.659 3.329 7.953 3.329 12.892z"/>
  45. <path style="fill:#111111;image-rendering:optimizeQuality;shape-rendering:geometricPrecision" d="m125.21 0 1.414 8.6-5.008 9.583s-1.924-4.064-5.117-6.314c-2.693-1.899-4.447-2.309-7.186-1.746-3.527.73-7.516 4.938-9.258 10.13-2.084 6.21-2.104 9.218-2.178 11.978-.115 4.428.58 7.043.58 7.043s-3.04-5.626-3.011-13.866c.018-5.882.947-11.218 3.666-16.479 2.404-4.627 5.954-7.404 9.114-7.728 3.264-.343 5.848 1.229 7.841 2.938 2.089 1.788 4.213 5.698 4.213 5.698l4.94-9.837z"/>
  46. <path style="fill:#111111;image-rendering:optimizeQuality;shape-rendering:geometricPrecision" d="m125.82 48.674s-2.208 3.957-3.589 5.48c-1.379 1.524-3.849 4.209-6.896 5.555-3.049 1.343-4.646 1.598-7.661 1.306-3.01-.29-5.807-2.032-6.786-2.764-.979-.722-3.486-2.864-4.897-4.854-1.42-2-3.634-5.995-3.634-5.995s1.233 4.001 2.007 5.699c.442.977 1.81 3.965 3.749 6.572 1.805 2.425 5.315 6.604 10.652 7.545 5.336.945 9.002-1.449 9.907-2.031.907-.578 2.819-2.178 4.032-3.475 1.264-1.351 2.459-3.079 3.116-4.108.487-.758 1.276-2.286 1.276-2.286l-1.276-6.644z"/>
  47. </symbol>
  48. <symbol id="tag" viewBox="0 0 177.16535 177.16535">
  49. <g transform="translate(0 -875.2)">
  50. <path style="fill-rule:evenodd;stroke-width:0;fill:#111111" d="m159.9 894.3-68.79 8.5872-75.42 77.336 61.931 60.397 75.429-76.565 6.8495-69.755zm-31.412 31.835a10.813 10.813 0 0 1 1.8443 2.247 10.813 10.813 0 0 1 -3.5174 14.872l-.0445.0275a10.813 10.813 0 0 1 -14.86 -3.5714 10.813 10.813 0 0 1 3.5563 -14.863 10.813 10.813 0 0 1 13.022 1.2884z"/>
  51. </g>
  52. </symbol>
  53. <symbol id="balloon" viewBox="0 0 141.73228 177.16535">
  54. <g transform="translate(0 -875.2)">
  55. <g>
  56. <path style="fill:#1a1a1a" d="m68.156 882.83-.88753 1.4269c-4.9564 7.9666-6.3764 17.321-5.6731 37.378.36584 10.437 1.1246 23.51 1.6874 29.062.38895 3.8372 3.8278 32.454 4.6105 38.459 4.6694-.24176 9.2946.2879 14.377 1.481 1.2359-3.2937 5.2496-13.088 8.886-21.623 6.249-14.668 8.4128-21.264 10.253-31.252 1.2464-6.7626 1.6341-12.156 1.4204-19.764-.36325-12.93-2.1234-19.487-6.9377-25.843-2.0833-2.7507-6.9865-7.6112-7.9127-7.8436-.79716-.20019-6.6946-1.0922-6.7755-1.0248-.02213.0182-5.0006-.41858-7.5248-.22808l-2.149-.22808h-3.3738z"/>
  57. <path style="fill:#1a1a1a" d="m61.915 883.28-3.2484.4497c-1.7863.24724-3.5182.53481-3.8494.63994-2.4751.33811-4.7267.86957-6.7777 1.5696-.28598 0-1.0254.20146-2.3695.58589-5.0418 1.4418-6.6374 2.2604-8.2567 4.2364-6.281 7.6657-11.457 18.43-12.932 26.891-1.4667 8.4111.71353 22.583 5.0764 32.996 3.8064 9.0852 13.569 25.149 22.801 37.517 1.3741 1.841 2.1708 2.9286 2.4712 3.5792 3.5437-1.1699 6.8496-1.9336 10.082-2.3263-1.3569-5.7831-4.6968-21.86-6.8361-33.002-.92884-4.8368-2.4692-14.322-3.2452-19.991-.68557-5.0083-.77707-6.9534-.74159-15.791.04316-10.803.41822-16.162 1.5026-21.503 1.4593-5.9026 3.3494-11.077 6.3247-15.852z"/>
  58. <path style="fill:#1a1a1a" d="m94.499 885.78c-.10214-.0109-.13691 0-.0907.0409.16033.13489 1.329 1.0675 2.5976 2.0723 6.7003 5.307 11.273 14.568 12.658 25.638.52519 4.1949.24765 14.361-.5059 18.523-2.4775 13.684-9.7807 32.345-20.944 53.519l-3.0559 5.7971c2.8082.76579 5.7915 1.727 8.9926 2.8441 11.562-11.691 18.349-19.678 24.129-28.394 7.8992-11.913 11.132-20.234 12.24-31.518.98442-10.02-1.5579-20.876-6.7799-28.959-.2758-.4269-.57803-.86856-.89617-1.3166-3.247-6.13-9.752-12.053-21.264-16.131-2.3687-.86369-6.3657-2.0433-7.0802-2.1166z"/>
  59. <path style="fill:#1a1a1a" d="m32.52 892.22c-.20090-.13016-1.4606.81389-3.9132 2.7457-11.486 9.0476-17.632 24.186-16.078 39.61.79699 7.9138 2.4066 13.505 5.9184 20.562 5.8577 11.77 14.749 23.219 30.087 38.74.05838.059.12188.1244.18052.1838 1.3166-.5556 2.5965-1.0618 3.8429-1.5199-.66408-.32448-1.4608-1.3297-3.8116-4.4602-5.0951-6.785-8.7512-11.962-13.051-18.486-5.1379-7.7948-5.0097-7.5894-8.0586-13.054-6.2097-11.13-8.2674-17.725-8.6014-27.563-.21552-6.3494.13041-9.2733 1.775-14.987 2.1832-7.5849 3.9273-10.986 9.2693-18.07 1.7839-2.3656 2.6418-3.57 2.4409-3.7003z"/>
  60. <path style="fill:#1a1a1a" d="m69.133 992.37c-6.2405.0309-12.635.76718-19.554 2.5706 4.6956 4.7759 9.935 10.258 12.05 12.625l4.1272 4.6202h11.493l3.964-4.4516c2.0962-2.3541 7.4804-7.9845 12.201-12.768-8.378-1.4975-16.207-2.6353-24.281-2.5955z"/>
  61. <rect style="stroke-width:0;fill:#1a1a1a" ry="2.0328" height="27.746" width="22.766" y="1017.7" x="60.201"/>
  62. </g>
  63. </g>
  64. </symbol>
  65. <symbol id="info" viewBox="0 0 41.667 41.667">
  66. <g transform="translate(-37.035 -1004.6)">
  67. <path style="stroke-linejoin:round;stroke:currentColor;stroke-linecap:round;stroke-width:3.728;fill:none" d="m76.25 1030.2a18.968 18.968 0 0 1 -23.037 13.709 18.968 18.968 0 0 1 -13.738 -23.019 18.968 18.968 0 0 1 23.001 -13.768 18.968 18.968 0 0 1 13.798 22.984"/>
  68. <g transform="matrix(1.1146 0 0 1.1146 -26.276 -124.92)">
  69. <path style="stroke:currentColor;stroke-linecap:round;stroke-width:3.728;fill:none" d="m75.491 1039.5v-8.7472"/>
  70. <path style="stroke-width:0;fill:currentColor" transform="scale(-1)" d="m-73.193-1024.5a2.3719 2.3719 0 0 1 -2.8807 1.7142 2.3719 2.3719 0 0 1 -1.718 -2.8785 2.3719 2.3719 0 0 1 2.8763 -1.7217 2.3719 2.3719 0 0 1 1.7254 2.8741"/>
  71. </g>
  72. </g>
  73. </symbol>
  74. <symbol id="warning" viewBox="0 0 48.430474 41.646302">
  75. <g transform="translate(-1.1273 -1010.2)">
  76. <path style="stroke-linejoin:round;stroke:currentColor;stroke-linecap:round;stroke-width:4.151;fill:none" d="m25.343 1012.3-22.14 37.496h44.28z"/>
  77. <path style="stroke:currentColor;stroke-linecap:round;stroke-width:4.1512;fill:none" d="m25.54 1027.7v8.7472"/>
  78. <path style="stroke-width:0;fill:currentColor" d="m27.839 1042.8a2.3719 2.3719 0 0 1 -2.8807 1.7143 2.3719 2.3719 0 0 1 -1.718 -2.8785 2.3719 2.3719 0 0 1 2.8763 -1.7217 2.3719 2.3719 0 0 1 1.7254 2.8741"/>
  79. </g>
  80. </symbol>
  81. <symbol id="menu" viewBox="0 0 50 50">
  82. <rect style="stroke-width:0;fill:currentColor" height="10" width="50" y="0" x="0"/>
  83. <rect style="stroke-width:0;fill:currentColor" height="10" width="50" y="20" x="0"/>
  84. <rect style="stroke-width:0;fill:currentColor" height="10" width="50" y="40" x="0"/>
  85. </symbol>
  86. </svg>
  87. <div class="wrapper">
  88. <header class="intro-and-nav" role="banner">
  89. <div>
  90. <div class="intro">
  91. <a class="logo" href="https://heydon.github.io/infusion/" aria-label="Infusion pattern library home page">
  92. <img src="https://heydon.github.io/infusion/images/logo.png" alt="">
  93. </a>
  94. <p class="library-desc">Documentation for the <strong>Infusion</strong> pattern library builder. This documentation is constructed using the builder itself.</p>
  95. </div>
  96. <nav id="patterns-nav" class="patterns" role="navigation">
  97. <button id="menu-button" aria-expanded="false">
  98. <svg viewBox="0 0 50 50" width="50" height="50">
  99. <use xlink:href="#menu"></use>
  100. </svg>
  101. Menu
  102. </button>
  103. <ul id="patterns-list">
  104. <li class="pattern">
  105. <a href="https://heydon.github.io/infusion/patterns/installation/" >
  106. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  107. <span class="text">Installation</span>
  108. </a>
  109. </li>
  110. <li class="pattern">
  111. <a href="https://heydon.github.io/infusion/patterns/library-setup/" aria-current="page">
  112. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  113. <span class="text">Library setup</span>
  114. </a>
  115. </li>
  116. <li class="pattern">
  117. <a href="https://heydon.github.io/infusion/patterns/serving/" >
  118. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  119. <span class="text">Serving</span>
  120. </a>
  121. </li>
  122. <li>
  123. <h3>Writing</h3>
  124. <ul>
  125. <li class="pattern">
  126. <a href="https://heydon.github.io/infusion/patterns/writing/library-structure/" >
  127. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  128. <span class="text">Library structure</span>
  129. </a>
  130. </li>
  131. <li class="pattern">
  132. <a href="https://heydon.github.io/infusion/patterns/writing/markdown-and-metadata/" >
  133. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  134. <span class="text">Markdown &amp; metadata</span>
  135. </a>
  136. </li>
  137. <li class="pattern">
  138. <a href="https://heydon.github.io/infusion/patterns/writing/expandable-sections/" >
  139. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  140. <span class="text">Expandable sections</span>
  141. </a>
  142. </li>
  143. <li class="pattern">
  144. <a href="https://heydon.github.io/infusion/patterns/writing/notes-and-warnings/" >
  145. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  146. <span class="text">Notes &amp; warnings</span>
  147. </a>
  148. </li>
  149. <li class="pattern">
  150. <a href="https://heydon.github.io/infusion/patterns/writing/references/" >
  151. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  152. <span class="text">References</span>
  153. </a>
  154. </li>
  155. <li class="pattern">
  156. <a href="https://heydon.github.io/infusion/patterns/writing/tables-of-contents/" >
  157. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  158. <span class="text">Tables of contents</span>
  159. </a>
  160. </li>
  161. </ul>
  162. </li>
  163. <li>
  164. <h3>Media</h3>
  165. <ul>
  166. <li class="pattern">
  167. <a href="https://heydon.github.io/infusion/patterns/media/including-images/" >
  168. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  169. <span class="text">Including images</span>
  170. </a>
  171. </li>
  172. <li class="pattern">
  173. <a href="https://heydon.github.io/infusion/patterns/media/including-videos/" >
  174. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  175. <span class="text">Including videos</span>
  176. </a>
  177. </li>
  178. </ul>
  179. </li>
  180. <li>
  181. <h3>Coding</h3>
  182. <ul>
  183. <li class="pattern">
  184. <a href="https://heydon.github.io/infusion/patterns/coding/code-blocks/" >
  185. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  186. <span class="text">Code blocks</span>
  187. </a>
  188. </li>
  189. <li class="pattern">
  190. <a href="https://heydon.github.io/infusion/patterns/coding/demo-embedding/" >
  191. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  192. <span class="text">Demo embedding</span>
  193. </a>
  194. </li>
  195. <li class="pattern">
  196. <a href="https://heydon.github.io/infusion/patterns/coding/writing-inline-demos/" >
  197. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  198. <span class="text">Writing inline demos</span>
  199. </a>
  200. </li>
  201. <li class="pattern">
  202. <a href="https://heydon.github.io/infusion/patterns/coding/color-palettes/" >
  203. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  204. <span class="text">Color palettes</span>
  205. </a>
  206. </li>
  207. <li class="pattern">
  208. <a href="https://heydon.github.io/infusion/patterns/coding/command-line/" >
  209. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  210. <span class="text">Command line</span>
  211. </a>
  212. </li>
  213. <li class="pattern">
  214. <a href="https://heydon.github.io/infusion/patterns/coding/file-trees/" >
  215. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  216. <span class="text">File trees</span>
  217. </a>
  218. </li>
  219. <li class="pattern">
  220. <a href="https://heydon.github.io/infusion/patterns/coding/tested/" >
  221. <svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>
  222. <span class="text">Tested using...</span>
  223. </a>
  224. </li>
  225. </ul>
  226. </li>
  227. </ul>
  228. </nav>
  229. </div>
  230. </header>
  231. <div class="main-and-footer">
  232. <div>
  233. <main id="main">
  234. <h1>Library setup</h1>
  235. <nav class="toc" aria-labelledby="toc-heading">
  236. <h2 id="toc-heading">Table of contents</h2>
  237. <ol>
  238. <li>
  239. <a href="#cleaning-the-content-folder">
  240. “Cleaning” the content folder
  241. </a>
  242. </li>
  243. <li>
  244. <a href="#the-config-file">
  245. The config file
  246. </a>
  247. </li>
  248. <li>
  249. <a href="#including-a-logo">
  250. Including a logo
  251. </a>
  252. </li>
  253. </ol>
  254. </nav>
  255. <p>By now, you should have followed the <a class="pattern-link" href="https://heydon.github.io/infusion/patterns/installation/"><svg class="bookmark" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>Installation</a> instructions. You should have Hugo and Node installed, and a local copy of a forked version of <strong>Infusion</strong>. You should also have run <code>npm install</code> in the root of that codebase.</p>
  256. <h2 id="cleaning-the-content-folder">&ldquo;Cleaning&rdquo; the content folder</h2>
  257. <p>Before you can start documenting patterns, there are a few things still to do in order to get set up. At the moment, your version of <strong>Infusion</strong> is a facsimile of the original, containing all this documentation content. We want to delete that content and replace it with some starter content. There&rsquo;s a simple <code>clean</code> command for this.</p>
  258. <aside aria-label="warning" class="note warning">
  259. <div>
  260. <svg aria-hidden="true" viewBox="0 0 48.430474 41.646302">
  261. <use xlink:href="#warning"></use>
  262. </svg>
  263. <p>If you are contributing to an existing <strong>Infusion</strong> library, do not run the following command. It will delete all of the patterns in that library. The <code>clean</code> command is just for libraries that you are starting from scratch.</p>
  264. </div>
  265. </aside>
  266. <pre class="cmd"><code> npm run clean</code></pre>
  267. <p>This will leave your <code>content</code> folder with just an <code>_index.md</code> file and a <code>patterns</code> folder containing a single demonstration pattern file. Find out more about these in <a class="pattern-link" href="https://heydon.github.io/infusion/patterns/writing/library-structure/"><svg class="bookmark" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>Library structure</a>.</p>
  268. <h2 id="the-config-file">The config file</h2>
  269. <p>You&rsquo;ll also want to name your library and configure one or two other things in the <code>config.toml</code> file that&rsquo;s found at the root of your project. Here&rsquo;s how that file looks:</p>
  270. <pre class="language-html line-numbers"><code class="language-html" data-codeblock-shortcode>
  271. languageCode = "en-us"
  272. title = "Infusion"
  273. baseURL = "https://heydon.github.io/infusion/"
  274. theme = "infusion"
  275. [params]
  276. description = "Documentation for the **Infusion** pattern library builder. This documentation is constructed using the builder itself."
  277. codePenUser = "Heydon"
  278. </code></pre>
  279. <ul>
  280. <li><strong>title</strong> — This is the library&rsquo;s name, like &ldquo;Megacorp 5000 Pattern Library&rdquo;. You don&rsquo;t have to include the term &ldquo;pattern library&rdquo; if you don&rsquo;t want to. For <strong>Infusion&rsquo;s</strong> own version of <strong>Infusion</strong>, the <code>title</code> is, naturally, <em>Infusion</em> :-)</li>
  281. <li><strong>baseURL</strong> — This is the root of the live site. Typically you will publish the site to Github Pages, so this should be the base URL for your Github Pages site.</li>
  282. <li><strong>theme</strong> — This is the theme the library is using. Don&rsquo;t change this from &ldquo;infusion&rdquo;.</li>
  283. <li><strong>description</strong> — This is a short description of the library and comes under the logo. You can include markdown syntax here, like <em>&#x002a;&#x002a;Infusion&#x002a;&#x002a;</em> in the above example for making the name of the library bold.</li>
  284. <li><strong>codePenUser</strong> — If you want to embed codePens in your pattern files, you need to supply a codePen username here.</li>
  285. </ul>
  286. <h2 id="including-a-logo">Including a logo</h2>
  287. <p>In the <code>images/static</code> folder, you&rsquo;ll find a <code>logo.png</code> file. Replace this file with your own company or project logo. Currently, only the PNG format is supported.</p>
  288. <p>Now that your logo&rsquo;s in place, everything should be ready. Where next? You can learn about <a class="pattern-link" href="https://heydon.github.io/infusion/patterns/writing/library-structure/"><svg class="bookmark" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>Library structure</a> to help you get writing, or find out how to serve the library locally and on Github Pages in <a class="pattern-link" href="https://heydon.github.io/infusion/patterns/serving/"><svg class="bookmark" aria-hidden="true" viewBox="0 0 40 50"><use xlink:href="#bookmark"></use></svg>Serving</a>.</p>
  289. </main>
  290. <footer role="contentinfo">
  291. Powered by <strong>Infusion</strong>, a <strong>The Paciello Group</strong> project.<br>
  292. For general enquiries, contact us on info@paciellogroup.com.
  293. </footer>
  294. </div>
  295. </div>
  296. </div>
  297. <script src="https://heydon.github.io/infusion/js/prism.js"></script>
  298. <script src="https://heydon.github.io/infusion/js/dom-scripts.js"></script>
  299. </body>
  300. </html>