Usage #
-Prerequisites #
+Usage #
+Prerequisites #
It is assumed, that you
- have basic knowledge, how to use Visual Studio Code.
- successfully installed μJam extension to VSCode.
Activation #
+Activation #
μJam is an extension to VSCode and VSCode will activate it under certain conditions. As μJam deals primarily – or more precise exclusively – with markdown files, it will get activated, when you either
- open your first markdown file, or ... @@ -88,13 +88,13 @@
- belonging to a repository having an entry
"microjam": {...}
in itspackage.json
Activation #
only.
-Generating Webpages #
+Generating Webpages #
μJam can do exactly two things for you:
- generate/update a
html
file from a singlemd
file ... - generate/update
html
files from allmd
files in a repository
Single Markdown Files #
+Single Markdown Files #
Whenever you are working at a markdown file and save it via
- menu
File > Save As
or (Ctrl + Shift + S) or ...
@@ -110,7 +110,7 @@
Single Markdown Files All Markdown Files #
+All Markdown Files #
There might come up the necessity to rebuild all html
files. One scenario is, we just had modified our templates in template.js
.
To achieve this, we can use the μJam command Ctrl + K A (think All).
All Markdown Files Menus #
+Menus #
![](./img/mu-jam.use.04-1.png)
![](./img/mu-jam.use.04-2.png)
@@ -137,7 +137,7 @@
Menus #
Note:
Menus in VSCode are defined statically with extensions like μJam. So above menus are always shown while editing any markdown document. But with markdown documents not belonging to a valid repository invoking these menu commands will silently have no effect.
Manually Remove Files #
+Manually Remove Files #
You won't want to remove auto-generated files usually, as they are regularly updated by μJam. But if you explicitely want to do that, it you can use the explorer view (Fig. 5).
![](./img/mu-jam.use.05.png)
Manually Remove Files Editing Markdown Files #
+Editing Markdown Files #
It is not much to say here, since markdown editing is excellently done by VSCode editor. There are only a few assisting μJam features worth mentioning.
-Frontmatter Snippet #
+Frontmatter Snippet #
When starting a new markdown file, μJam assists you by inserting a partial filled frontmatter template at current editor location.
![](./img/mu-jam.use.06.png)
Simply type Ctrl+k - for getting this.
-Table Of Content Snippet #
+Table Of Content Snippet #
When finishing a markdown document containing several headings possibly in multiple levels, we would welcome an automatic generation of a table of contents (toc). This is inserted at current editor location by μJam at our fingertips.
![](./img/mu-jam.use.07.png)