Skip to content

Commit

Permalink
Add page on What is Fontist?
Browse files Browse the repository at this point in the history
  • Loading branch information
alexeymorozov committed Feb 22, 2022
1 parent 26a3a5b commit f601904
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@ _site/
.jekyll-cache/
.jekyll-metadata
.DS_Store
.bundle/
Gemfile.lock

.rubocop-https--*
12 changes: 12 additions & 0 deletions _layouts/docs.html
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 }}
71 changes: 71 additions & 0 deletions _pages/docs.adoc
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")
----
4 changes: 4 additions & 0 deletions nav-links.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@
<input type="search" id="siteSearchInput" placeholder="Type to search…">
</div>

{% include nav-page-link.html htmlclass="docs" url="/docs/" title="Docs" active_for_nested=true %}

{% include nav-page-link.html htmlclass="software" url="/software/" title="Software" active_for_nested=true %}

<!-- {% include nav-page-link.html htmlclass="fonts" url="/fonts/" title="Fonts" active_for_nested=true %} -->

{% include project-nav.html %}

{% include nav-page-link.html htmlclass="blog" url="/blog/" title="Blog" active_for_nested=true %}

<a href="javascript: void 0;" class="search" aria-label="site search button"><i class="fas fa-search"></i></a>

0 comments on commit f601904

Please sign in to comment.