Skip to content

Commit

Permalink
improve readability with proper usage of Markdown <kbd> tag (goessner#80
Browse files Browse the repository at this point in the history
)
  • Loading branch information
kirisakow committed Apr 5, 2020
1 parent abf7936 commit d74ada5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ npm install
* Launch *VS Code*, create or open a markdown file (`.md`).
* Open a preview window.
* Typeset in your markdown source window and see the preview window live updating.
* Press <kbd>Ctrl+K ,</kbd> or run the command `Save Markdown+Math to HTML` to save the corresponding HTML source to the file system.
* Press <kbd>Ctrl+K .</kbd> or run the command `Clip Markdown+Math to HTML` to copy the corresponding HTML source to the underlying systems clipboard.
* Press <kbd>Ctrl</kbd>+<kbd>K</kbd><kbd>,</kbd> or run the command `Save Markdown+Math to HTML` to save the corresponding HTML source to the file system.
* Press <kbd>Ctrl</kbd>+<kbd>K</kbd><kbd>.</kbd> or run the command `Clip Markdown+Math to HTML` to copy the corresponding HTML source to the underlying systems clipboard.

## User Settings

Expand Down Expand Up @@ -135,7 +135,7 @@ npm install
* __Are there global predefined macros ?__
* No. Macros are user defined with user settings `mdmath.macros`. So they are available in all user specific markdown documents.
* __Can I write the HTML source to a file ?__
* Yes. Use the <kbd>Markdown: Save Markdown+Math to Html</kbd> command or the key binding (`'ctrl+K ,'`).
* Yes. Use the `Markdown: Save Markdown+Math to Html` command or the key binding <kbd>Ctrl</kbd>+<kbd>K</kbd><kbd>,</kbd>.
* The Html file is written to the folder where the markdown file resides in. This is the default.
* You can change the destination folder by specifying a relative path to your working directory with the help of the user setting `mdmath.savePath`. So for an example you might choose `mdmath.savePath: "./html/${file.name}.html"`.
* __Can I synchronously let the HTML source file update ?__
Expand Down Expand Up @@ -167,7 +167,7 @@ npm install
* __Can I use math markup in code blocks ?__
* No, math markup in code blocks is shown - as expected - as markup. This is consistent now, but in contrast to `mdmath` versions prior to 2.0.
* __Can I access the HTML source of the markdown file ?__
* Yes. Use the <kbd>Markdown: Clip Markdown+Math to Html</kbd> command or the key binding (`'ctrl+K .'`).
* Yes. Use the `Markdown: Clip Markdown+Math to Html` command or the key binding <kbd>Ctrl</kbd>+<kbd>K</kbd><kbd>.</kbd>.
* The markdown preview window has to be opened once for this in order to function properly.
* You need to have the markdown source window activated here (not the preview window!).
* Please note, that the resulting HTML source references 'CDN'-located remote css files. Change those references to local URL's if necessary.
Expand Down

0 comments on commit d74ada5

Please sign in to comment.