Skip to content

Instantly share code, notes, and snippets.

@simov
Last active December 27, 2025 17:26
Show Gist options
  • Select an option

  • Save simov/ffc7517d7c1a7223b714218d1b01fdd2 to your computer and use it in GitHub Desktop.

Select an option

Save simov/ffc7517d7c1a7223b714218d1b01fdd2 to your computer and use it in GitHub Desktop.
Notes to the reviewer

Markdown Viewer - Build Instructions

Markdown Viewer is an open source browser extension hosted on GitHub: https://github.com/simov/markdown-viewer/tree/firefox

Build the themes and vendor folders, and create the markdown-viewer.zip package:

cd markdown-viewer/
sh build/package.sh firefox

Build Dependencies

  • node 18
  • npm 10
  • git
  • zip

Operating System

Ubuntu 22.04.3 LTS (jammy) 5.19.0-50-generic

Build Summary

Library Outputs + Build Strategy
bootstrap vendor/bootstrap.min.css (copy file)
csso vendor/csso.min.js (copy file)
markdown-it vendor/markdown-it/ (folder - copy js files)
mathjax vendor/mathjax/ (folder - copy js & font files)
mdc vendor/mdc/ (folder - copy js files)
vendor/mdc.min.css (build + minify)
mermaid vendor/mermaid.min.js (copy file)
mithril vendor/mithril.min.js (copy file)
panzoom vendor/panzoom.min.js (copy file)
prism vendor/prism/ (folder - copy js files)
vendor/prism.js (copy file)
vendor/prism.min.css (modify + copy)
vendor/prism-okaidia.min.css (modify + copy)
themes themes/ (folder - copy + update + minify css files)

bootstrap

build/bootstrap/ https://github.com/simov/markdown-viewer/tree/firefox/build/bootstrap

sh build/bootstrap/build.sh
module version source
bootstrap 5.3.3 https://github.com/twbs/bootstrap/tree/v5.3.3

csso

build/csso/ https://github.com/simov/markdown-viewer/tree/firefox/build/csso

sh build/csso/build.sh
module version source
csso 5.0.5 https://github.com/css/csso/tree/v5.0.5
  • vendor/csso.min.css
    node_modules/csso/dist/csso.js

markdown-it

build/markdown-it/ https://github.com/simov/markdown-viewer/tree/firefox/build/markdown-it

sh build/markdown-it/build.sh
module version source
markdown-it 13.0.1 https://github.com/markdown-it/markdown-it/tree/13.0.1
markdown-it-abbr 1.0.4 https://github.com/markdown-it/markdown-it-abbr/tree/1.0.4
markdown-it-anchor 8.6.7 https://github.com/valeriangalliat/markdown-it-anchor/tree/v8.6.7
markdown-it-attrs 4.1.6 https://github.com/arve0/markdown-it-attrs/tree/v4.1.6
markdown-it-cjk-breaks 1.1.3 https://github.com/markdown-it/markdown-it-cjk-breaks/tree/1.1.3
markdown-it-deflist 2.1.0 https://github.com/markdown-it/markdown-it-deflist/tree/2.1.0
markdown-it-footnote 3.0.3 https://github.com/markdown-it/markdown-it-footnote/tree/3.0.3
markdown-it-ins 3.0.1 https://github.com/markdown-it/markdown-it-ins/tree/3.0.1
markdown-it-mark 3.0.1 https://github.com/markdown-it/markdown-it-mark/tree/3.0.1
markdown-it-sub 1.0.0 https://github.com/markdown-it/markdown-it-sub/tree/1.0.0
markdown-it-sup 1.0.0 https://github.com/markdown-it/markdown-it-sup/tree/1.0.0
markdown-it-task-lists 2.1.1 https://github.com/revin/markdown-it-task-lists

mathjax

build/mathjax/ https://github.com/simov/markdown-viewer/tree/firefox/build/mathjax

sh build/mathjax/build.sh
module version source
mathjax 3.2.2 https://github.com/mathjax/MathJax/tree/3.2.2

mdc

build/mdc/ https://github.com/simov/markdown-viewer/tree/firefox/build/mdc

sh build/mdc/build.sh
module version source
@material/button 0.37.1 https://github.com/material-components/material-components-web/tree/v0.37.1
@material/ripple 0.37.1 https://github.com/material-components/material-components-web/tree/v0.37.1
@material/switch 0.36.1 https://github.com/material-components/material-components-web/tree/v0.36.1
@material/tabs 0.37.1 https://github.com/material-components/material-components-web/tree/v0.37.1
@material/textfield 0.37.1 https://github.com/material-components/material-components-web/tree/v0.37.1
  • vendor/mdc/mdc.ripple.min.js
    node_modules/@material/ripple/dist/mdc.ripple.min.js
  • vendor/mdc/mdc.tabs.min.js
    node_modules/@material/tabs/dist/mdc.tabs.min.js
  • vendor/mdc/mdc.textfield.min.js
    node_modules/@material/textfield/dist/mdc.textfield.min.js
  • vendor/mdc.min.css (build + minified)

mermaid

build/mermaid/ https://github.com/simov/markdown-viewer/tree/firefox/build/mermaid

sh build/mermaid/build.sh
module version source
mermaid 9.2.2 https://github.com/mermaid-js/mermaid/tree/v9.2.2
  • vendor/mermaid.min.js
    node_modules/mermaid/dist/mermaid.min.js

mithril

build/mithril/ https://github.com/simov/markdown-viewer/tree/firefox/build/mithril

sh build/mithril/build.sh
module version source
mithril 1.1.7 https://github.com/MithrilJS/mithril.js/tree/v1.1.7

panzoom

build/panzoom/ https://github.com/simov/markdown-viewer/tree/firefox/build/panzoom

sh build/panzoom/build.sh
module version source
@panzoom/panzoom 4.5.1 https://github.com/timmywil/panzoom/tree/4.5.1
  • vendor/panzoom.min.js
    node_modules/@panzoom/panzoom/dist/panzoom.min.js

prism

build/prism/ https://github.com/simov/markdown-viewer/tree/firefox/build/prism

sh build/prism/build.sh
module version source
prismjs 1.30.0 https://github.com/PrismJS/prism/tree/v1.30.0

themes

build/themes/ https://github.com/simov/markdown-viewer/tree/firefox/build/themes

sh build/themes/build.sh
module version source
cleanrmd 0.1.0 https://github.com/gadenbuie/cleanrmd/tree/v0.1.0
github-markdown-css 5.5.1 https://github.com/sindresorhus/github-markdown-css/tree/v5.5.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment