kianga
/
obsidian-auto-typography
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add build instructions

This commit is contained in:
Kianga 2023-05-21 16:01:18 +02:00
parent 086533ac7e
commit 52a7dae4db
Signed by: kianga
SSH Key Fingerprint: SHA256:FsfHSVtt4BSm5AV+MG3KYJplFo8Q8+TWvSeud7Um4Oo
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,6 +1,6 @@
# Auto-Typography for Obsidian
This is a simple plugin for Obsidian that converts ASCII typography to the correct Unicode symbols for English writing, similar to the original [SmartyPants plugin](https://daringfireball.net/projects/smartypants/) by John Gruber.
This is a simple plugin for [Obsidian](https://obsidian.md) that converts ASCII typography to the correct Unicode symbols for English writing, similar to the original [SmartyPants plugin](https://daringfireball.net/projects/smartypants/) by John Gruber.
Text is replaced in **reading mode only**. This plugin does not interfere during editing or in live-preview mode, and Markdown files are never modified.
@ -15,6 +15,12 @@ Text is replaced in **reading mode only**. This plugin does not interfere during
## Notes
This is my first Obsidian plugin; I made it for my personal use and it's intentionally simple. There is currently no configuration, and no support for other languages or different kinds of quotation marks. More features might be added in the future.
This is my first Obsidian plugin; I made it for practice and for my personal use and it's intentionally simple. There is currently no configuration, and no support for other languages or different kinds of quotation marks. More features might be added in the future.
The plugin registers a `MarkdownPostProcessor` and affects text nodes in the DOM tree only; this should prevent it from interfering with other plugins or replacing CSS classes or HTML attributes by accident.
The plugin registers a `MarkdownPostProcessor` and affects text nodes in the rendered DOM tree only; this should prevent it from interfering with other plugins by replacing CSS classes or HTML attributes by accident.
## Development
[NodeJS 18.16.0 LTS](https://nodejs.org) is required for development.
After checkout, run `npm install` to fetch dependencies. `npm run build` to compile, then copy `manifest.json` and `main.js` to `VAULT/.obsidian/plugins/obsidian-auto-typography/` to install and enable the plugin under *Settings - Community Plugins*.