fontifyjs v0.0.4

FontifyJS

Forget to optimize a large number of fonts and imported automatically in React/JSProject and use it for Tailwind or directly to use it with pure .css

Index

1. ‼️ Usage ‼️
2. 🗒️ Manual Configuration 🗒️
   • Steps before execute
   • What will happen?
   • Tailwind
3. Example Without Tailwind (Pure CSS)
4. ⚠️ Things to keep in mind

IMPORTANT

Do not use the Node/Deno runtime, for more compatibility use Bun

‼️ Usage ‼️

• ✅ ZIP with disorganized and unoptimized sources, is not a problem with Fontify!

/fontify.js/{your_project}

import { FontifyJS } from "fontifyjs";

FontifyJS({ projectDir: 'my-project' });

Native Typescript (In Maintenance, do not use)

/fontify.ts/{your_project}

import { FontifyJS } from "fontifyjs/ts";

FontifyJS({ projectDir: 'my-project' });

🧯 Steps before execute

• Put all of your zip-font files inside of /{your_project}/fontLoader
• Do not put other type of file that is not a .zip file inside of fontLoader
• Put only in the main directory (/fontLoader) the zip files, not in subdirectorys

🔥 Execute

Most compatible:

bun fontify.js

Recommended (Typed Version):

bun fontify.ts

What will happen?

3 temporary folders will be created for the organization, decompression and optimization of the fonts in the main folder of the project and then the fonts will be saved in /public/fonts/fontify in different folders for each of the zips to be used.

🗒️ Manual Configuration 🗒️

When you want to use Tailwind, Fontify provides two files. The css file of all configurate fonts of all fonts (.ttf) in the all zips to .woff2, and create a tailwind configure file for configure in tailwind.config.js the fontFamily. And inside exports an object to use directly to the tailwind file. Examples:

.
└── my-project
    ...
    ├── fontify.css
    └── fontifyTailwind.js

/{your_project}/fontify.css (EXAMPLE)

/*
Thanks for using FonitfyJS here can you manage all of the proccesed fonts for your project, enjoy!
*/
@tailwind utilities;

@font-face {
    font-family: 'AGDASIMA_agdasima_regular'; /*👁️ (NameFolder) + (_) + (NameFont)*/
    src: url('./public/fonts/fontify/agdasima/agdasima_regular.woff2') format('woff2');
}, ...

/{your_project}/fontifyTailwind.js (EXAMPLE)

/* 
 * Tailwind's configuration from FontFamily
*/
export const configFontifyFonts = {
  "AGDASIMA_agdasima_regular": [ /*👁️ (NameFolder) + (_) + (NameFont)*/
    "AGDASIMA_agdasima_regular", 
    "sans-serif"
  ],
  "AGDASIMA_agdasima_bold": [
    "AGDASIMA_agdasima_bold",
    "sans-serif"
  ], ...

tailwind.config.js (REAL CONFIGURATION) 👁️

import { configFontifyFonts } from './fontifyTailwind'; /*👈 IMPORT*/

/** @type {import('tailwindcss').Config} */
export default {
  content: [
    "./index.html",
    "./src/**/*.{js,ts,jsx,tsx}",
  ],
  theme: {
    extend: {
      fontFamily: configFontifyFonts /*👈 ADD OBJECT IMPORTED*/
    },
  },
  plugins: [],
}

Example React Usage 👁️

When execute Fontify all of your font files are organized in custom folder in /public/font/fontify/....

Tailwind ‼️

If you want to access your fonts through tawilwind, its syntax would be to add to the class: font-. And then the name of the zip where the font comes from is added in capital letters of the entire word, plus a _ and finally the name of the file that is in the public path.

/{your_project}/src/App.jsx

import '../fontify.css';
...

export function App() {

    /* How to acces the font? */
    return(
        <div className="font-NAMEFOLDER_namefont">
        </div>
    )
}

Example React Project

.
├── fontify.js
└── my-project
    ├── README.md
    ├── eslint.config.js
    ├── fontLoader
    │   ├── Agdasima copy.zip
    │   ├── Agdasima.zip
    │   └── Roboto.zip
    ├── fontify.css
    ├── fontifyTailwind.js
    ├── index.html
    ├── package-lock.json
    ├── package.json
    ├── postcss.config.js
    ├── public
    │   ├── fonts
    │   │   └── fontify
    │   │       ├── agdasima
    │   │       │   ├── agdasima_bold.woff2     #👈 AGDASIMA_agdasima_bold
    │   │       │   └── agdasima_regular.woff2  #👈 AGDASIMA_agdasima_regular
    │   │       ├── agdasima_copy
    │   │       │   ├── agdasima_bold.woff2     #👈 AGDASIMA_COPY_agdasima_bold
    │   │       │   └── agdasima_regular.woff2  #👈 AGDASIMA_COPY_agdasima_regular
    │   │       └── roboto
    │   │           ├── roboto_black.woff2          #👈 ROBOTO_roboto_black
    │   │           ├── roboto_blackitalic.woff2    #👈 ROBOTO_roboto_blackitalic
    │   │           ├── roboto_bold.woff2
    │   │           ├── roboto_bolditalic.woff2
    │   │           ├── roboto_italic.woff2
    │   │           ├── roboto_light.woff2
    │   │           ├── roboto_lightitalic.woff2
    │   │           ├── roboto_medium.woff2
    │   │           ├── roboto_mediumitalic.woff2
    │   │           ├── roboto_regular.woff2
    │   │           ├── roboto_thin.woff2
    │   │           └── roboto_thinitalic.woff2
    │   └── vite.svg
    ├── src
    │   ├── App.css
    │   ├── App.jsx
    │   ├── assets
    │   │   └── react.svg
    │   ├── index.css
    │   └── main.jsx
    ├── tailwind.config.js
    └── vite.config.js

Example Without Tailwind (Pure CSS) 👁️

index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Custom Font Example</title>
  
  <!-- Vincula tu archivo CSS con la fuente -->
  <link href="./fontify.css" rel="stylesheet">

  <style>
    /* Aplica la fuente en todo el cuerpo */
    body {
      font-family: 'NAMEFOLDER_namefont', sans-serif;
    }
  </style>
</head>
<body>
  <h1>Custom Font Example with NAMEFOLDER</h1>
  <p>This paragraph is using the 'NAMEFOLDER_namefont' font.</p>
</body>
</html>

⚠️ Things to keep in mind

• If there are repeated source files, internally it will use the repeated files in different folders to avoid compatibility errors between different names.

Things to improve

• Manage more better the logs
• Add to my github profile the project
• Add more keywords relationate to the lib