massivebox/syspell
massivebox/syspell
1
0
Fork 0
generated from mirrors/plugin-sample-vite-svelte
Code Issues Pull requests Projects Releases 3 Packages Wiki Activity Actions
A fully featured grammar checker for SiYuan, like Grammarly or LanguageTool, which supports multiple languages and custom dictionaries.
3 commits 1 branch 3 tags 223 KiB
Find a file
Exact
MassiveBox a13ac05afb
All checks were successful
Build on Push and create Release on Tag / build (push) Successful in 1m18s
Details
Fix CI build error
2025-09-19 23:47:33 +02:00
.forgejo/workflows First commit 2025-09-19 21:18:06 +02:00
asset Initial commit 2025-09-19 19:16:32 +00:00
public/i18n First commit 2025-09-19 21:18:06 +02:00
scripts Fix CI build error 2025-09-19 23:47:33 +02:00
src First commit 2025-09-19 21:18:06 +02:00
.gitignore Initial commit 2025-09-19 19:16:32 +00:00
CHANGELOG.md Initial commit 2025-09-19 19:16:32 +00:00
icon.png First commit 2025-09-19 21:18:06 +02:00
LICENSE Initial commit 2025-09-19 19:16:32 +00:00
package.json Fix CI build error 2025-09-19 23:47:33 +02:00
plugin.json First commit 2025-09-19 21:18:06 +02:00
preview.png First commit 2025-09-19 21:18:06 +02:00
README.md First commit 2025-09-19 21:18:06 +02:00
svelte.config.js Initial commit 2025-09-19 19:16:32 +00:00
tsconfig.json Initial commit 2025-09-19 19:16:32 +00:00
tsconfig.node.json Initial commit 2025-09-19 19:16:32 +00:00
vite.config.ts Initial commit 2025-09-19 19:16:32 +00:00
yaml-plugin.js Initial commit 2025-09-19 19:16:32 +00:00

README.md

📝 SySpell - Grammar and Spell Checker for SiYuan

This plugin adds a fully featured grammar and spell checker for SiYuan, powered by LanguageTool.

📃 Usage instructions

  1. Install the plugin from the SiYuan plugin store and enable it
  2. (Optional) Visit the plugin settings to configure it for your needs
  3. Words and phrases which are recognized as wrong will be underlined in red
  4. Right-click over an underlined word (or click the Menu keyboard button), hover on "Plugin", then...
    • Click the error message to get a detailed explanation of the error
    • Click "Add to dictionary" to permanently ignore the error
    • Click any of the corrections to apply them

☑️ Features

  • Spell checker

  • Grammar checker like Grammarly

  • Free and open-source

  • Self-hostable grammar checking server

  • Underlines are not edited into your notes

    Why does this matter?

    The plugin's underlines are not rendered by altering the content of your note, but as an overlay. This way, when exporting notes from SiYuan to HTML or Markdown, the underlines aren't shown, and they don't interfere with your writing.
    It's just like how the Grammarly web extensions works!

Check out the Projects for the planned features!

🛠 Contributing

I'm respecting LanguageTool's guidelines by running a LanguageTool server, on my own hardware, for the benefit of this plugin's users, instead of having them use the official one.
I'm providing this service for free, but it's not free for me to run it: the LanguageTool server is very resource intensive.
If you can, consider donating to help me keep it up forever. Thanks!

You can also contribute by opening an issue or a pull request. Thanks!

🤗 Thanks to

This project couldn't have been possible without (in no particular order):

Make sure you check them out and support them as well!

📜 License

The original plugin framework is developed by SiYuan 思源笔记 and licensed under the MIT license.
All changes made by me are copyright MassiveBox 2025, and licensed under the MIT license.