fontist 1.18.2 → 1.20.0

data/docs/guide/index.md

@@ -0,0 +1,67 @@
+# Getting started
+
+The easiest way to get started with Fontist is to install the Fontist CLI. There's also a [fontist RubyGem package](/guide/api-ruby) that you can use from your Ruby code.
+
+```sh
+gem install fontist
+```
+
+💎 Don't have Ruby installed? You can [download Ruby from the official Ruby website](https://www.ruby-lang.org/en/downloads/).
+
+Now you're ready to start using Fontist to install fonts on your machine! 🤩
+
+```sh
+fontist install "Fira Code"
+fontist install "Open Sans"
+fontist install "Consolas"
+```
+
+<sup>👩‍⚖️ Some fonts may require you to accept license terms regarding their use.</sup>
+
+## Using a Fontist manifest
+
+Several fonts can be specified in a file, called "manifest", and installed together.
+
+First, prepare a file "manifest.yml":
+
+```yaml
+---
+Times New Roman:
+Arial:
+Courier New:
+---
+```
+
+Then run:
+
+```sh
+fontist manifest-install manifest.yml
+```
+
+```
+---
+Arial:
+  Regular:
+    full_name: Arial
+    paths:
+    - "/home/octocat/.fontist/fonts/Arial.ttf"
+  Bold Italic:
+    ...
+```
+
+💡 You can use `fontist manifest-locations` to get the installation paths of **only the fonts listed in the manifest file**.
+
+```sh
+fontist manifest-locations manifest.yml
+```
+
+```
+---
+Arial:
+  Regular:
+    full_name: Arial
+    paths:
+    - "/home/octocat/.fontist/fonts/Arial.ttf"
+  Bold Italic:
+    ...
+```

data/docs/guide/proxy.md

@@ -0,0 +1,47 @@
+# Using Fontist with a proxy
+
+Fontist uses Git internally for fetching formulas and fonts.
+
+In order to use Git functionality behind a proxy, you need to update your own
+Git config via the `git config` command or the `~/.gitconfig` preference file.
+
+There are many ways to configure your local Git install to use proxies.
+
+The simplest, global way of setting a proxy for Git is the following.
+
+For HTTP
+
+```sh
+git config --global http.proxy http://{user}:{pass}@{proxyhost}:{port}
+```
+
+For HTTPS, you may need to handle SSL/TLS verification errors after setting
+the proxy since the encryption end is located at your HTTPS proxy endpoint:
+
+```sh
+git config --global http.proxy https://{user}:{pass}@{proxyhost}:{port}
+git config --global https.proxy https://{user}:{pass}@{proxyhost}:{port}
+```
+
+For SOCKS, you will need to decide on the SOCKS protocol:
+
+```sh
+git config --global http.proxy '{protocol}://{user}:{pass}@{proxyhost}:{port}'
+git config --global https.proxy '{protocol}://{user}:{pass}@{proxyhost}:{port}'
+```
+
+For example,
+
+```sh
+git config --global http.proxy 'socks5h://user:pass@socks-proxy.example.org'
+git config --global https.proxy 'socks5h://user:pass@socks-proxy.example.org'
+```
+
+The list of supported SOCKS protocols for the `{protocol}` field:
+
+- `socks://`: for SOCKS below v5
+- `socks5://`: for SOCKS v5
+- `socks5h://`: for SOCKS below v5 + host resolution via SOCKS
+
+You could actually set different proxy behavior for individual Git repositories
+— please see this [great guide](https://gist.github.com/evantoli/f8c23a37eb3558ab8765) on how to use Git proxies (thanks to the GitHub user [evantoli](https://github.com/evantoli)).

data/docs/guide/why.md

@@ -0,0 +1,7 @@
+# Why Fontist?
+
+In general, fonts can be downloaded manually and placed in a system folder. Some fonts are even pre-installed with an OS. **This is inconsistent across Windows, macOS, and Linux.**
+
+Fontist is a higher level abstraction that lets you use `fontist install` (or the `Fontist::Fontist` Ruby library) to manage your fonts with the same API across multiple platforms.
+
+Fontist 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.

data/docs/index.md

@@ -0,0 +1,40 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  # name: "Fontist"
+  text: "Manage your fonts effortlessly"
+  tagline: Fontist brings cross-platform font management to the command line for Windows, Linux, and macOS. Free and open source.
+  image:
+    src: /hero.png
+  actions:
+    - theme: brand
+      text: 🚀 Get started
+      link: /guide/
+    - theme: alt
+      text: 💎 Ruby API
+      link: /guide/api-ruby
+    - theme: alt
+      text: 🍰 Formulas
+      link: https://fontist.org/formulas/
+      target: _self
+---
+
+<!-- Excerpt from the Getting Started guide page. Try to keep it in sync! -->
+
+```sh
+gem install fontist
+```
+
+💎 Don't have Ruby installed? You can [download Ruby from the official Ruby website](https://www.ruby-lang.org/en/downloads/).
+
+Now you're ready to start using Fontist to install fonts on your machine! 🤩
+
+```sh
+fontist install "Fira Code"
+fontist install "Open Sans"
+fontist install "Consolas"
+```
+
+[📚 Read more in the Getting Started guide](/guide/)