fontist 2.1.3 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (169) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/docs.yml +70 -0
  3. data/.github/workflows/links.yml +100 -0
  4. data/.gitignore +3 -1
  5. data/Gemfile +1 -0
  6. data/docs/.vitepress/config.ts +170 -32
  7. data/docs/.vitepress/data/cli-commands.json +461 -0
  8. data/docs/.vitepress/data/exit-codes.json +21 -0
  9. data/docs/.vitepress/data/features.json +44 -0
  10. data/docs/.vitepress/theme/components/HeroCodeBlock.vue +98 -0
  11. data/docs/.vitepress/theme/components/WithinHero.vue +30 -0
  12. data/docs/.vitepress/theme/index.ts +12 -0
  13. data/docs/.vitepress/theme/style.css +152 -0
  14. data/docs/api/errors.md +211 -0
  15. data/docs/api/font.md +101 -0
  16. data/docs/api/fontconfig.md +82 -0
  17. data/docs/api/formula.md +103 -0
  18. data/docs/api/index.md +49 -0
  19. data/docs/api/manifest.md +209 -0
  20. data/docs/cli/cache.md +100 -0
  21. data/docs/cli/config.md +123 -0
  22. data/docs/cli/create-formula.md +71 -0
  23. data/docs/cli/exit-codes.md +73 -0
  24. data/docs/cli/fontconfig.md +85 -0
  25. data/docs/cli/import.md +140 -0
  26. data/docs/cli/index-cmd.md +37 -0
  27. data/docs/cli/index.md +80 -0
  28. data/docs/cli/install.md +52 -0
  29. data/docs/cli/list.md +39 -0
  30. data/docs/cli/manifest.md +110 -0
  31. data/docs/cli/repo.md +142 -0
  32. data/docs/cli/status.md +39 -0
  33. data/docs/cli/uninstall.md +34 -0
  34. data/docs/cli/update.md +31 -0
  35. data/docs/cli/version.md +38 -0
  36. data/docs/components/CliCommand.vue +77 -0
  37. data/docs/components/CliExamples.vue +17 -0
  38. data/docs/components/CliOptions.vue +26 -0
  39. data/docs/components/ExitCodes.vue +18 -0
  40. data/docs/guide/ci.md +4 -0
  41. data/docs/guide/concepts/fonts.md +158 -0
  42. data/docs/guide/concepts/formats.md +234 -0
  43. data/docs/guide/concepts/index.md +109 -0
  44. data/docs/guide/concepts/licenses.md +236 -0
  45. data/docs/guide/concepts/requirements.md +388 -0
  46. data/docs/guide/concepts/variable-fonts.md +212 -0
  47. data/docs/guide/formulas.md +265 -0
  48. data/docs/guide/how-it-works.md +428 -0
  49. data/docs/guide/index.md +26 -47
  50. data/docs/guide/installation.md +167 -0
  51. data/docs/guide/maintainer/import.md +372 -0
  52. data/docs/guide/maintainer/index.md +37 -0
  53. data/docs/guide/manifests.md +132 -0
  54. data/docs/guide/platforms/index.md +72 -0
  55. data/docs/guide/platforms/macos.md +151 -0
  56. data/docs/guide/platforms/windows.md +220 -0
  57. data/docs/guide/quick-start.md +76 -0
  58. data/docs/guide/why.md +4 -0
  59. data/docs/index.md +55 -23
  60. data/docs/lychee.toml +33 -0
  61. data/docs/package-lock.json +9 -114
  62. data/docs/package.json +3 -5
  63. data/docs/public/apple-touch-icon.png +0 -0
  64. data/docs/public/favicon-96x96.png +0 -0
  65. data/docs/public/favicon.ico +0 -0
  66. data/docs/public/favicon.svg +1 -0
  67. data/docs/public/logo-full.svg +1 -0
  68. data/docs/public/logo.svg +1 -0
  69. data/docs/public/site.webmanifest +21 -0
  70. data/docs/public/web-app-manifest-192x192.png +0 -0
  71. data/docs/public/web-app-manifest-512x512.png +0 -0
  72. data/fontist.gemspec +0 -1
  73. data/lib/fontist/cache/manager.rb +0 -2
  74. data/lib/fontist/cache.rb +6 -0
  75. data/lib/fontist/cli/thor_ext.rb +0 -2
  76. data/lib/fontist/cli.rb +0 -10
  77. data/lib/fontist/collection_file.rb +0 -3
  78. data/lib/fontist/font.rb +0 -6
  79. data/lib/fontist/font_collection.rb +0 -1
  80. data/lib/fontist/font_file.rb +0 -1
  81. data/lib/fontist/font_installer.rb +0 -5
  82. data/lib/fontist/font_model.rb +0 -1
  83. data/lib/fontist/font_path.rb +0 -2
  84. data/lib/fontist/formula.rb +0 -13
  85. data/lib/fontist/formula_picker.rb +0 -2
  86. data/lib/fontist/google_import_source.rb +0 -2
  87. data/lib/fontist/import/convert_formulas.rb +0 -2
  88. data/lib/fontist/import/create_formula.rb +0 -4
  89. data/lib/fontist/import/files/collection_file.rb +0 -1
  90. data/lib/fontist/import/files.rb +8 -0
  91. data/lib/fontist/import/font_metadata_extractor.rb +0 -1
  92. data/lib/fontist/import/formula_builder.rb +0 -6
  93. data/lib/fontist/import/google/api.rb +0 -9
  94. data/lib/fontist/import/google/data_sources/base.rb +0 -1
  95. data/lib/fontist/import/google/data_sources/github.rb +0 -3
  96. data/lib/fontist/import/google/data_sources/ttf.rb +0 -2
  97. data/lib/fontist/import/google/data_sources/vf.rb +0 -2
  98. data/lib/fontist/import/google/data_sources/woff2.rb +0 -2
  99. data/lib/fontist/import/google/data_sources.rb +13 -0
  100. data/lib/fontist/import/google/font_database.rb +0 -10
  101. data/lib/fontist/import/google/metadata_adapter.rb +0 -1
  102. data/lib/fontist/import/google/models/font_family.rb +0 -1
  103. data/lib/fontist/import/google/models/metadata.rb +1 -9
  104. data/lib/fontist/import/google/models/source_metadata.rb +0 -1
  105. data/lib/fontist/import/google/models.rb +16 -0
  106. data/lib/fontist/import/google.rb +7 -2
  107. data/lib/fontist/import/google_fonts_importer.rb +0 -5
  108. data/lib/fontist/import/google_import.rb +1 -8
  109. data/lib/fontist/import/helpers.rb +8 -0
  110. data/lib/fontist/import/macos.rb +0 -6
  111. data/lib/fontist/import/manual_formula_builder.rb +0 -2
  112. data/lib/fontist/import/models.rb +7 -0
  113. data/lib/fontist/import/otf/font_file.rb +0 -2
  114. data/lib/fontist/import/otf.rb +7 -0
  115. data/lib/fontist/import/recursive_extraction.rb +0 -5
  116. data/lib/fontist/import/sil_import.rb +0 -3
  117. data/lib/fontist/import/upgrade_formulas.rb +1 -11
  118. data/lib/fontist/import.rb +23 -0
  119. data/lib/fontist/import_cli.rb +0 -9
  120. data/lib/fontist/index.rb +0 -4
  121. data/lib/fontist/index_cli.rb +0 -2
  122. data/lib/fontist/indexes/base_font_collection_index.rb +0 -1
  123. data/lib/fontist/indexes/default_family_font_index.rb +0 -2
  124. data/lib/fontist/indexes/directory_snapshot.rb +0 -2
  125. data/lib/fontist/indexes/filename_index.rb +0 -2
  126. data/lib/fontist/indexes/font_index.rb +0 -3
  127. data/lib/fontist/indexes/fontist_index.rb +0 -2
  128. data/lib/fontist/indexes/incremental_index_updater.rb +0 -4
  129. data/lib/fontist/indexes/preferred_family_font_index.rb +0 -2
  130. data/lib/fontist/indexes/system_index.rb +0 -2
  131. data/lib/fontist/indexes/user_index.rb +0 -2
  132. data/lib/fontist/indexes.rb +18 -0
  133. data/lib/fontist/install_location.rb +0 -4
  134. data/lib/fontist/install_locations/fontist_location.rb +0 -2
  135. data/lib/fontist/install_locations/system_location.rb +0 -2
  136. data/lib/fontist/install_locations/user_location.rb +0 -2
  137. data/lib/fontist/install_locations.rb +8 -0
  138. data/lib/fontist/macos/catalog/asset.rb +0 -2
  139. data/lib/fontist/macos/catalog/base_parser.rb +0 -1
  140. data/lib/fontist/macos/catalog/catalog_manager.rb +0 -6
  141. data/lib/fontist/macos/catalog/font3_parser.rb +0 -2
  142. data/lib/fontist/macos/catalog/font4_parser.rb +0 -2
  143. data/lib/fontist/macos/catalog/font5_parser.rb +0 -2
  144. data/lib/fontist/macos/catalog/font6_parser.rb +0 -2
  145. data/lib/fontist/macos/catalog/font7_parser.rb +0 -2
  146. data/lib/fontist/macos/catalog/font8_parser.rb +0 -2
  147. data/lib/fontist/macos/catalog.rb +15 -0
  148. data/lib/fontist/macos.rb +5 -0
  149. data/lib/fontist/macos_import_source.rb +0 -2
  150. data/lib/fontist/manifest_request.rb +0 -1
  151. data/lib/fontist/manifest_response.rb +0 -1
  152. data/lib/fontist/resources.rb +7 -0
  153. data/lib/fontist/sil_import_source.rb +0 -2
  154. data/lib/fontist/system_font.rb +0 -2
  155. data/lib/fontist/system_index.rb +0 -4
  156. data/lib/fontist/utils/cache.rb +0 -2
  157. data/lib/fontist/utils/downloader.rb +0 -4
  158. data/lib/fontist/utils.rb +10 -8
  159. data/lib/fontist/validate_cli.rb +0 -4
  160. data/lib/fontist/validator.rb +0 -2
  161. data/lib/fontist/version.rb +1 -1
  162. data/lib/fontist.rb +82 -36
  163. metadata +75 -22
  164. data/.github/workflows/deploy-pages.yml +0 -54
  165. data/.github/workflows/release.yml.orig +0 -36
  166. data/docs/guide/api-ruby.md +0 -189
  167. data/docs/public/hero.png +0 -0
  168. data/docs/public/logo.png +0 -0
  169. data/docs/reference/index.md +0 -143
data/docs/reference/index.md DELETED
@@ -1,143 +0,0 @@
1
- # Fontist CLI reference
2
-
3
- <!-- This can be converted to a folder & multiple pages at any time. -->
4
-
5
- ## `fontist cache`
6
-
7
- The only subcommand available on `fontist cache` is `fontist cache clear`. It clears the `~/.fontist` cache.
8
-
9
- ```sh
10
- fontist cache clear
11
- ```
12
-
13
- ```
14
- Cache has been successfully removed.
15
- ```
16
-
17
- ## `fontist config`
18
-
19
- `fontist config` lets you edit the Fontist config file from the command line instead of opening an editor. There are four subcommands available:
20
-
21
- - `fontist config delete <key>`
22
- - `fontist config keys`
23
- - `fontist config set <key> <value>`
24
- - `fontist config show`
25
-
26
- Here's an example of these commands being used to edit the config file:
27
-
28
- ```sh
29
- fontist config keys
30
- fontist config set font_path /var/myfonts
31
- fontist config delete font_path
32
- fontist config show
33
- ```
34
-
35
- ```
36
- $ fontist config keys
37
- Available keys:
38
- fonts_path (default: /home/octocat/.fontist/fonts)
39
- open_timeout (default: 60)
40
- read_timeout (default: 60)
41
-
42
- $ fontist config set fonts_path /var/myfonts
43
- 'fonts_path' set to '/var/myfonts'.
44
-
45
- $ fontist config delete fonts_path
46
- 'fonts_path' reset to default ('/home/octocat/.fontist/fonts').
47
-
48
- $ fontist config show
49
- Config is empty.
50
- ```
51
-
52
- ### Config reference
53
-
54
- <!-- Move this into its own '/reference/config' page if this grows a lot. -->
55
-
56
- - **`fonts_path`:** Where to put the `.ttf` files. Defaults to `~/.fontist/fonts`
57
-
58
- - **`open_timeout`:** Defaults to 60.
59
-
60
- - **`read_timeout`:** Defaults to 60.
61
-
62
- ## `fontist status [font-name]`
63
-
64
- Prints the paths to a particular installed font or all fonts if the `font-name` is omitted. This searches **all fonts available on your system** even those not managed by Fontist.
65
-
66
- ```sh
67
- fontist status
68
- ```
69
-
70
- ```
71
- Fonts found at:
72
- - /usr/share/fonts/truetype/ubuntu/UbuntuMono-B.ttf
73
- - /usr/share/fonts/truetype/ubuntu/UbuntuMono-BI.ttf
74
- - /usr/share/fonts/truetype/ubuntu/UbuntuMono-R.ttf
75
- - /usr/share/fonts/truetype/ubuntu/UbuntuMono-RI.ttf
76
- - /home/octocat/.fontist/fonts/Arial.ttf (from ms_truetype formula)
77
- - /home/octocat/.fontist/fonts/ArialBI.ttf (from ms_truetype formula)
78
- - /home/octocat/.fontist/fonts/ArialBd.ttf (from ms_truetype formula)
79
- - /home/octocat/.fontist/fonts/ArialI.ttf (from ms_truetype formula)
80
- ```
81
-
82
- Here's an example narrowed to a specific font:
83
-
84
- ```sh
85
- fontist status "Open Sans"
86
- ```
87
-
88
- ```
89
- Fonts found at:
90
- - /home/octocat/.fontist/fonts/OpenSans-Bold.ttf (from open_sans formula)
91
- - /home/octocat/.fontist/fonts/OpenSans-BoldItalic.ttf (from open_sans formula)
92
- - /home/octocat/.fontist/fonts/OpenSans-Italic.ttf (from open_sans formula)
93
- - /home/octocat/.fontist/fonts/OpenSans-Regular.ttf (from open_sans formula)
94
- ```
95
-
96
- ## `fontist list [font-name]`
97
-
98
- Lists the installation status of `font-name` or all fonts if no font name provided.
99
-
100
- ```sh
101
- fontist status
102
- ```
103
-
104
- ```
105
- Fonts found at:
106
- - /usr/share/fonts/truetype/ubuntu/UbuntuMono-B.ttf
107
- - /usr/share/fonts/truetype/ubuntu/UbuntuMono-BI.ttf
108
- - /usr/share/fonts/truetype/ubuntu/UbuntuMono-R.ttf
109
- - /usr/share/fonts/truetype/ubuntu/UbuntuMono-RI.ttf
110
- - /home/octocat/.fontist/fonts/Arial.ttf (from ms_truetype formula)
111
- - /home/octocat/.fontist/fonts/ArialBI.ttf (from ms_truetype formula)
112
- - /home/octocat/.fontist/fonts/ArialBd.ttf (from ms_truetype formula)
113
- - /home/octocat/.fontist/fonts/ArialI.ttf (from ms_truetype formula)
114
- ```
115
-
116
- Here's an example getting the status of a specific font:
117
-
118
- ```sh
119
- fontist status "Fira Mono"
120
- ```
121
-
122
- ```
123
- Font "Fira Mono" not found locally.
124
- 'Fira Mono' font is missing, please run `fontist install 'Fira Mono'` to download the font.
125
- ```
126
-
127
- ## Environment variables
128
-
129
- ### `FONTIST_PATH`
130
-
131
- By default Fontist uses the `~/.fontist` directory to store fonts and its files. It can be changed with the `FONTIST_PATH` environment variable.
132
-
133
- ```sh
134
- FONTIST_PATH=/var/fontist2 fontist update
135
- ```
136
-
137
- ## Excluded fonts
138
-
139
- `fontist` excludes some fonts from usage when they break other software:
140
-
141
- - `NISC18030.ttf` (GB18030 Bitmap) - macOS [fontist/fontist#344](https://github.com/fontist/fontist/issues/344)
142
-
143
- [📑 View the up-to-date list of known problematic fonts on GitHub](https://github.com/fontist/fontist/blob/main/lib/fontist/exclude.yml)