search

awth13 / org-appear

Toggle visibility of hidden Org mode element parts upon entering and leaving an element
MIT License
375 stars 19 forks source link

Document Org variables that should be set to hide elements #51

Closed albertfgu closed 1 year ago

albertfgu commented 1 year ago

Thanks for this amazing package! I had wanted something like this the last time I configured my org-mode settings two years ago, and am really glad this feature now exists.

I wanted to point out that the documentation makes it sound like setting flags like org-appear-autoemphasis is sufficient to create the hiding/appearing functionality, but it wasn't working for me and I had to dig into the source code to find out that you also have to independently set the original org-mode flags like org-hide-emphasis-markers to turn on the hide functionality first. I can see now that it was implicit in the README but I think it wasn't super obvious. This PR documents the extra org-mode flags that need to be set for each type of element.

awth13 commented 1 year ago

Hello, @albertfgu! Glad you're enjoying org-appear.

You're right, the README was not very clear on the extra setting flags that must be enabled. Thank you for your contribution!