{"id":18595741,"url":"https://github.com/goessner/microjam","last_synced_at":"2025-04-10T16:31:42.780Z","repository":{"id":45043479,"uuid":"247246881","full_name":"goessner/microjam","owner":"goessner","description":"A minimalistic Jamstack approach for creating GitHub-Pages hosted sites.","archived":false,"fork":false,"pushed_at":"2022-01-12T23:01:29.000Z","size":4263,"stargazers_count":44,"open_issues_count":6,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-25T01:01:49.206Z","etag":null,"topics":["jamstack","markdown-to-html","static-site-generator","vscode-extension"],"latest_commit_sha":null,"homepage":"https://goessner.github.io/microjam/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/goessner.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-14T09:23:57.000Z","updated_at":"2023-08-15T15:30:22.000Z","dependencies_parsed_at":"2022-09-26T17:30:38.710Z","dependency_job_id":null,"html_url":"https://github.com/goessner/microjam","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goessner%2Fmicrojam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goessner%2Fmicrojam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goessner%2Fmicrojam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goessner%2Fmicrojam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/goessner","download_url":"https://codeload.github.com/goessner/microjam/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248125821,"owners_count":21051808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jamstack","markdown-to-html","static-site-generator","vscode-extension"],"created_at":"2024-11-07T01:21:07.995Z","updated_at":"2025-04-10T16:31:37.768Z","avatar_url":"https://github.com/goessner.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![microjam](https://goessner.github.io/microjam//img/icon128.png) \u0026mu;Jam\n\n[![marketplace](https://vsmarketplacebadge.apphb.com/version/goessner.microjam.svg)](https://marketplace.visualstudio.com/items?itemName=goessner.microjam)\n[![marketplace](https://vsmarketplacebadge.apphb.com/installs-short/goessner.microjam.svg)](https://marketplace.visualstudio.com/items?itemName=goessner.microjam)\n[![npm](https://img.shields.io/npm/v/microjam.svg)](https://www.npmjs.com/package/microjam)\n![Dependencies](https://goessner.github.io/microjam//img/dependencies-badge.png)\n[![License](https://img.shields.io/github/license/goessner/mdmath.svg)](https://github.com/goessner/microjam/blob/master/LICENSE.txt)\n\n## What is it ?\n\n**\u0026mu;Jam** allows to use *Visual Studio Code* as a lightweight authoring and publishing tool for small to medium websites.\n\nGreek letter `'μ'` is pronounced `'my'` as in `micro`, `'mu'` as in `'music'` or `'mee'` according to [modern Greek](https://www.thoughtco.com/the-greek-alphabet-1705558). In that context here it simply means *tiny* or  *minimalistic*.\n\nThat `'Jam'` in \u0026mu;Jam comes from `Jamstack` and means the collection of the three attributes\n* **J** avaScript\n* **A** PI\n* **M** arkup\n\nIt is mostly about the creation of static web pages or *serverless* websites and you might want to [read more](https://jamstack.org/) about that modern way to build lightweight web pages [here](https://jamstack.wtf/) and [there](https://jamstack.email/).\n\n## What can I do with it ?\n\nIf you want to \n* create a small to medium website\n* write down the contents of your web pages in that easy to learn and use [Markdown language](https://commonmark.org/help/)\n* publish your web-pages to your GitHub repository and [GitHub pages](https://pages.github.com/)\n* do that all from inside free [*Visual Studio Code*](https://code.visualstudio.com/) (`vscode`) editor\n\nthen the minimalistic and powerful approach of \u0026mu;Jam might convice you.\n\n\u003cimg src=\"https://github.com/goessner/microjam/raw/master/img/browser-view2.png\"\u003e\n\u003cbr\u003e\u003cbr\u003e\n\u003cimg src=\"https://github.com/goessner/microjam/raw/master/img/vscode-view2.png\"\u003e\n\n## Examples ?\n\nSome templates are here ...\n\n* [microjam-simple](https://github.com/goessner/microjam-simple) \u0026ndash; A simple website template for μJam\n* [microjam-tufte](https://github.com/goessner/microjam-tufte) \u0026ndash; A Tufte Style Template for μJam\n* [microjam-docs](https://github.com/goessner/microjam-docs) \u0026ndash; A documentation theme for μjam with sidebar\n* [microjam-g2](https://github.com/goessner/microjam-docs) \u0026ndash; A theme for μjam + g2\n\n## Why yet another Jamstack Approach ?\n\n**\u0026mu;Jam** is meant to be a [low code](https://en.wikipedia.org/wiki/Low-code_development_platform) authoring and web publishing tool for scientists, engineers and students, which ...\n\n\u003e *  is easy to learn and use.\n\u003e *  does not require web programming skills.\n\u003e *  can handle LaTeX math expressions natively.\n\u003e *  integrates static or dynamic vector graphics.\n\u003e *  integrates scripting capabilities.\n\u003e *  offers comfortable Html previewing.\n\u003e *  supports different templates and styles.\n\u003e *  enables high quality research paper `pdf`-format output.\n\u003e *  doing that all inside of a professional markdown authoring application.\n\nBut as you can easily leave that *math*, *vector graphics* and *research paper* stuff out, it may serve your non-academic publishing wishes also well.\n\nInterested ... ?  So [read on](https://goessner.github.io/microjam/index.html) ...\n\n## [FAQ](./docs/faq.md)\n\n## Release Notes\n\n###  [0.4.0] on July 22, 2020\n* Update to KaTeX v.0.12.0. \n* permanently load 'markdown-it-texmath' and KaTeX.\n* Enable/disable math rules in `markdown-it` plugin on file level, based on frontmatter `\"math\":true` setting.\n* Introducing data entry `${data.base}` holding the relative path from the current markdown file \nto the `'docs'` folder.\n* Accessing that relative path `${data.base}` in *reused* markdown files (`navigation.md` etc.) is possible via macro `{base}`.\n\n###  [0.3.8] on June 21, 2020\n* Organization of markdown files in subdirectories `docs/*.md` having extension `md` under `docs` is possible. \n* Using `docs/*.md` subdirectories requires existence of a single `\u003cbase\u003e` Html element in the template header section.\n* **Breaking Change**: `\"use\"` entry in frontmatter sections is renamed to `\"uses\"`.\n* Layout names are not restricted now. Ensure that there is a corresponding template.\n\n###  [0.3.7] on June 17, 2020\n* Inline TeX expression `$$..$$` will result in display math presentation now.\n* Custom HTML elements `g-2` and `mec-2` are supported. \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoessner%2Fmicrojam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoessner%2Fmicrojam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoessner%2Fmicrojam/lists"}