-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
26a3a5b
commit f601904
Showing
4 changed files
with
89 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,5 +9,7 @@ _site/ | |
.jekyll-cache/ | ||
.jekyll-metadata | ||
.DS_Store | ||
.bundle/ | ||
Gemfile.lock | ||
|
||
.rubocop-https--* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
layout: docs-base | ||
html-class: docs-page | ||
docs_title: Fontist | ||
navigation: | ||
base_url: /docs | ||
items: | ||
- title: What is Fontist? | ||
path: / | ||
--- | ||
|
||
{{ content }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
layout: docs | ||
title: What is Fontist? | ||
html-class: overview | ||
--- | ||
:page-liquid: | ||
|
||
= What is Fontist? | ||
|
||
Fontist is a simple library to find and download fonts for Windows, Linux and | ||
Mac. | ||
|
||
It uses a formula repository to find where to download a requested font. The | ||
main formula repository contains a lot of fonts, including Google Fonts, SIL | ||
Fonts, and macOS add-on fonts. | ||
|
||
== Why use Fontist when there are other ways to install fonts? | ||
|
||
In general, fonts can be downloaded manually and placed in a system folder. | ||
Some fonts are even pre-installed with an OS. But fontist allows to install | ||
fonts programmatically and consistently on all platforms (Windows, macOS, and | ||
Linux): missing fonts would be installed, existing ones would be found and | ||
their paths returned. | ||
|
||
=== Install font | ||
|
||
E.g., the following command would find where to download and install the Arial | ||
font: | ||
|
||
[source,sh] | ||
---- | ||
fontist install "arial" | ||
---- | ||
|
||
=== Install a bunch of fonts | ||
|
||
It also allows to install several fonts with a single command. | ||
|
||
Image you have a file: | ||
|
||
[source,yaml] | ||
---- | ||
# manifest.yml | ||
--- | ||
Times New Roman: | ||
Arial: | ||
Courier New: | ||
---- | ||
|
||
Then running: | ||
|
||
[source,sh] | ||
---- | ||
fontist manifest-install manifest.yml | ||
---- | ||
|
||
Would install or find all 3 fonts, and return its paths. | ||
|
||
=== Use Ruby to install fonts | ||
|
||
Also Fontist allows to use its Ruby interface. The former tasks can be done with: | ||
|
||
[source,ruby] | ||
---- | ||
Fontist::Font.install("arial") | ||
---- | ||
|
||
[source,ruby] | ||
---- | ||
Fontist::Manifest::Install.from_file("manifest.yml") | ||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters