benjypng / logseq-wordcount-plugin

MIT License
31 stars 7 forks source link

Clarify documentation for character count #5

Closed devonzuegel closed 2 years ago

devonzuegel commented 2 years ago

Thank you for making this plugin, I love it!

The command \wordcount char wasn't working for me, so I dug into the code and realized that I could just put {{renderer :wordcountchar_RANDOM-ID}} directly, and that worked. So I updated the docs in case anyone else wants to use that method too.

benjypng commented 2 years ago

@devonzuegel! Thanks for your PR! Could I clarify which part wasn't working? Usually for plugins that register new slash commands, you have to restart Logseq in order to see them.

I've tested it on my end, and the command /wordcount char seems to work. I noticed that in your writeup, you used a backslash instead.

demo

devonzuegel commented 2 years ago

Oh silly me, I hadn't restarted 🙈 Sorry about that! You're right, it is working now that I've restarted.

Ah that's because in my config.edn, I've customized it use \ for my commands rather than /. That wasn't the source of the problem (it was that I hadn't restarted), but good eye!

Would you be open to a PR renaming /wordcount char → /character count? I think it makes more sense than having "word" in there, but it's ultimately your call of course as the maintainer!

benjypng commented 2 years ago

Great to hear!

Actually, you made a very good point. Not sure what I was thinking. I've already made the change and it's in v6 in the marketplace now!