logseq / docs

Logseq documentation
https://docs.logseq.com
MIT License
124 stars 90 forks source link

Italics syntax consistent with keyboard shortcut #96

Closed paulrudy closed 1 year ago

paulrudy commented 1 year ago

Italics in Logseq can be produced by surrounding text with single asterisks or single underscores. mod + i, the keyboard shortcut for italic formatting, surrounds highlighted text with asterisks. This PR changes the syntax suggestion for italic text to *Italics*, using asterisks, to match the results of using the keyboard shortcut.

It's worth noting that mod + b, the keyboard shortcut for bold formatting, surrounds highlighted text with double asterisks, which is consistent with the suggested syntax in this docs page. (And surrounding text with double underscores also produces bold text, but isn't mentioned)

paulrudy commented 1 year ago

Another note: For emphasis within a word, in either bold or italic, Logseq allows asterisks, but not underscores. This is in consistent with commonmark specifications: asterisks inside word, underscores inside word