Skip to content

Commit 46c30ff

Browse files
committed
docs: update mkdocs
1 parent 6fb8061 commit 46c30ff

File tree

3 files changed

+19
-17
lines changed

3 files changed

+19
-17
lines changed

.github/workflows/docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ jobs:
1313
- uses: actions/setup-python@v4
1414
with:
1515
python-version: 3.9.x
16-
- run: pip install mkdocs==1.1 mkdocs-material mkdocs-include-markdown-plugin mkdocs-git-revision-date-plugin
16+
- run: pip install mkdocs==1.5.2 mkdocs-material mkdocs-include-markdown-plugin mkdocs-git-revision-date-plugin
1717
- run: mkdocs gh-deploy --strict --force

mkdocs.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ theme:
1515
#- toc.integrate
1616
icon:
1717
logo: fontawesome/regular/file
18-
google_analytics:
19-
- UA-189971966-1
20-
- auto
18+
extra:
19+
analytics:
20+
provider: google
21+
property: G-91Z6LQXXFX
2122
markdown_extensions:
2223
- pymdownx.b64 #not working???
2324
- pymdownx.highlight

packages/troika-three-text/README.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -319,23 +319,24 @@ When a character is not covered by the configured `font` file, [unicode-font-res
319319
By default, the unicode-font-resolver data index and font files are loaded from the [jsDelivr CDN](https://www.jsdelivr.com/). If you wish to self-host those files you can do so; however be aware the full set of data and fonts is nearly 300MB.
320320

321321
To self-host the files:
322+
322323
- Go to the [unicode-font-resolver Github releases page](https://github.com/lojjic/unicode-font-resolver/releases)
323-
- Find the release matching the version of `@unicode-font-resolver/client` declared in [package.json](./package.json)'s `devDependencies`.
324+
- Find the release matching the version of `@unicode-font-resolver/client` declared in `troika-three-text/package.json`'s `devDependencies`.
324325
- Download the source code .zip or .tar.gz for that release and unpack it.
325326
- Copy the contents of the `packages/data/` directory to your server where you want to host it.
326327
- Configure troika-three-text to load from that server URL:
327-
- Per Text instance:
328-
```js
329-
text.unicodeFontsURL = 'https://my.host/unicode-fonts-data'
330-
```
331-
- Globally:
332-
```js
333-
import {configureTextBuilder} from 'troika-three-text'
334-
335-
configureTextBuilder({
336-
unicodeFontsURL: 'https://my.host/unicode-fonts-data'
337-
})
338-
```
328+
- Per Text instance:
329+
```js
330+
text.unicodeFontsURL = 'https://my.host/unicode-fonts-data'
331+
```
332+
- Globally:
333+
```js
334+
import {configureTextBuilder} from 'troika-three-text'
335+
336+
configureTextBuilder({
337+
unicodeFontsURL: 'https://my.host/unicode-fonts-data'
338+
})
339+
```
339340

340341
## Handling Asynchronous Updates
341342

0 commit comments

Comments
 (0)