# mkwebfont

mkwebfont is a simple tool for turning .ttf/.otf files into webfonts for self-hosting, without the complication or lack of flexibility that prepackaged webfonts or hosted webfonts have. It's designed to be an easy one-command solution that doesn't require complicated scripts or specific understanding of .woff2 or fonts to make work.

Like Google Fonts, it splits the fonts into subsets that allows only part of the font to be loaded as needed, usually based on the languages used.

## Usage

### Installation

To install it, simply run the following command:

```bash
cargo +nightly install mkwebfont
```

Alternatively, download an AppImage from the [releases page](https://github.com/Lymia/mkwebfont/releases).

### Basic Usage

Run the following command to create a basic webfont:

```bash
# Assumes that you serve `https://example.com/` from a directory of `/srv/http/webroot`.
# Adjust these paths for your use case
mkdir -p /srv/http/webroot/static/webfonts
mkwebfont \
    --store /srv/http/webroot/static/webfonts --store-uri "https://example.com/static/webfonts/" \
    -o /srv/http/webroot/static/fonts.css fonts/* 
```

After this, you can simply include the stylesheet at `https://example.com/static/fonts.css`, and then you can use any fonts that you included in the command line (e.g. with the `fonts/*` in the example) in your website.

### Usage for Static Websites

mkwebfont has special support for *completely static* websites that are use only HTML and CSS with no dynamic features. For these websites, it can automatically create webfonts that contain only glyphs actually used in the website and automatically download any fonts requested in the CSS (and available on Google Fonts) from the internet.

Run the following command to create webfonts for a static website:

```bash
# Assumes that you serve `https://example.com/` from a directory of `/srv/http/webroot`.
# Adjust these paths for your use case
mkdir -p /srv/http/webroot/static/webfonts
mkwebfont --store /srv/http/webroot/static/webfonts --webroot /srv/http/webroot/ --subset --write-to-webroot
```

Many advanced CSS features are not supposed, you will be warned if you use these. As a basic rule of thumb, do not use `var(--xx)`, or special values like `inherit` or `revert` for font-related CSS attributes. Consider using a CSS generator like SCSS to help avoid this if at all possible.

**WARNING:** Many of these warnings are not yet implemented in the alpha version. Additionally, some lesser used (but still common) functionality like support for the `style=` attribute is both unimplemented and does not have warnings.

**WARNING:** This *edits* the webroot rather than simply using it as a reference. In general, this functionality is designed to be called as part of a build process, not called on a manually constructed webroot. For that use, the basic usage instructions are far more appropriate.

### Fallback Font

When used on a static webpage, mkwebfont will generate a fallback webfont for all characters not available to render using user-provided fonts. The vast majority of Unicode characters are supported. The following fonts are used to create this fallback (in the following order):

* [Noto fonts](https://en.wikipedia.org/wiki/Noto_fonts) (Preferring Sans over Serif)
* [Kurinto Sans](https://www.kurinto.com/typefaces.htm)
* [Bablestone Han](https://www.babelstone.co.uk/Fonts/index.html)
* [Adobe Blank](https://github.com/adobe-fonts/adobe-blank) (**WARNING:** This is a fallback that does not render anything)

## License

This project is licensed under the Apache License Version 2.0.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in mkwebfont by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.