Have ideas to improve npm?Join in the discussion! »

microjamTypeScript icon, indicating that this package has built-in type declarations

0.4.2 • Public • Published

microjam μJam

marketplace marketplace npm Dependencies License

What is it ?

μJam allows to use Visual Studio Code as a lightweight authoring and publishing tool for small to medium websites.

Greek letter 'μ' is pronounced 'my' as in micro, 'mu' as in 'music' or 'mee' according to modern Greek. In that context here it simply means tiny or minimalistic.

That 'Jam' in μJam comes from Jamstack and means the collection of the three attributes

  • J avaScript
  • A PI
  • M arkup

It is mostly about the creation of static web pages or serverless websites and you might want to read more about that modern way to build lightweight web pages here and there.

What can I do with it ?

If you want to

  • create a small to medium website
  • write down the contents of your web pages in that easy to learn and use Markdown language
  • publish your web-pages to your GitHub repository and GitHub pages
  • do that all from inside free Visual Studio Code (vscode) editor

then the minimalistic and powerful approach of μJam might convice you.



Examples ?

Some templates are here ...

Why yet another Jamstack Approach ?

μJam is meant to be a low code authoring and web publishing tool for scientists, engineers and students, which ...

  • is easy to learn and use.
  • does not require web programming skills.
  • can handle LaTeX math expressions natively.
  • integrates static or dynamic vector graphics.
  • integrates scripting capabilities.
  • offers comfortable Html previewing.
  • supports different templates and styles.
  • enables high quality research paper pdf-format output.
  • doing that all inside of a professional markdown authoring application.

But as you can easily leave that math, vector graphics and research paper stuff out, it may serve your non-academic publishing wishes also well.

Interested ... ? So read on ...

FAQ

Release Notes

[0.4.0] on July 22, 2020

  • Update to KaTeX v.0.12.0.
  • permanently load 'markdown-it-texmath' and KaTeX.
  • Enable/disable math rules in markdown-it plugin on file level, based on frontmatter "math":true setting.
  • Introducing data entry ${data.base} holding the relative path from the current markdown file to the 'docs' folder.
  • Accessing that relative path ${data.base} in reused markdown files (navigation.md etc.) is possible via macro {base}.

[0.3.8] on June 21, 2020

  • Organization of markdown files in subdirectories docs/*.md having extension md under docs is possible.
  • Using docs/*.md subdirectories requires existence of a single <base> Html element in the template header section.
  • Breaking Change: "use" entry in frontmatter sections is renamed to "uses".
  • Layout names are not restricted now. Ensure that there is a corresponding template.

[0.3.7] on June 17, 2020

  • Inline TeX expression $$..$$ will result in display math presentation now.
  • Custom HTML elements g-2 and mec-2 are supported.

Install

npm i microjam

DownloadsWeekly Downloads

14

Version

0.4.2

License

MIT

Unpacked Size

1.95 MB

Total Files

79

Last publish

Collaborators

  • avatar