mii/obsidian-typst
1
0
Fork 0
mirror of https://github.com/mii443/obsidian-typst.git synced 2025-08-22 16:15:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

more docs

Browse Source
This commit is contained in:
Jack
2023-09-01 00:00:34 +01:00
parent 3c25eff8dd
commit d452136b0b
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -6,6 +6,7 @@
- Change output scaling/styling - Change output scaling/styling
- Selected fonts are now written in their fonts - Selected fonts are now written in their fonts
- Fix ([#12](https://github.com/fenjalien/obsidian-typst/issues/12)) - Fix ([#12](https://github.com/fenjalien/obsidian-typst/issues/12))
- [#18](https://github.com/fenjalien/obsidian-typst/pull/18)
# 0.5.1 # 0.5.1

10
README.md
View File

@ -3,11 +3,19 @@
Renders `typst` code blocks, and optionally math blocks, into images using [Typst](https://github.com/typst/typst) through the power of WASM! This is still very much in development, so suggestions and bugs are welcome! Renders `typst` code blocks, and optionally math blocks, into images using [Typst](https://github.com/typst/typst) through the power of WASM! This is still very much in development, so suggestions and bugs are welcome!
## Small Things to NOTE ## Small Things to NOTE
- This plugin uses Typst 0.7.0
- Typst does not currently support exporting to HTML only PDFs, PNGs and SVGs. So due to image scaling, the rendered views may look a bit terrible. If you know how to fix this PLEASE HELP. - Typst does not currently support exporting to HTML only PDFs, PNGs and SVGs. So due to image scaling, the rendered views may look a bit terrible. If you know how to fix this PLEASE HELP.
- File paths should be relative to the vault folder. - File paths should be relative to the vault folder.
- You can not import on mobile as file reading is NOT supported on mobile, this is due to `SharedArrayBuffer`s not being available on mobile but is available for some reason on desktop. - You can not import on mobile as file reading is NOT supported on mobile, this is due to `SharedArrayBuffer`s not being available on mobile but is available for some reason on desktop.
## Versions
| Plugin | Typst |
|-|-|
| 0.6 | [522708b](https://github.com/typst/typst/commit/522708b9df0b9b2f8265938aa1f0aeda8e6e6c1f) (Some commits after 0.7.0 to include SVG export) |
| 0.5 | 0.6.0 |
| 0.4 | 0.3.0 |
| 0.3 | 0.2.0 |
## Using Packages ## Using Packages
The plugin supports only the reading of packages from the [`@preview`](https://github.com/typst/packages#downloads) and [`@local`](https://github.com/typst/packages#local-packages) namespaces. Please use the Typst cli to download your desired packages. This means the plugin accesses files outside of your vault but only to read them, it does not modify or create files outside of your vault. The plugin supports only the reading of packages from the [`@preview`](https://github.com/typst/packages#downloads) and [`@local`](https://github.com/typst/packages#local-packages) namespaces. Please use the Typst cli to download your desired packages. This means the plugin accesses files outside of your vault but only to read them, it does not modify or create files outside of your vault.