crossnote 0.8.0

package/LICENSE.md

@@ -0,0 +1,17 @@
+University of Illinois/NCSA
+Open Source License
+
+```
+Copyright (c) 2017  Yiyi Wang
+All rights reserved.
+
+Developed by:     Yiyi Wang
+                  https://github.com/shd101wyy/mume
+```
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal with the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimers in the documentation and/or other materials provided with the distribution.
+Neither the names of Yiyi Wang, nor the names of its contributors may be used to endorse or promote products derived from this Software without specific prior written permission.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.

package/README.md

@@ -0,0 +1,289 @@
+# MUME
+
+[![Build Status](https://travis-ci.org/shd101wyy/mume.svg?branch=master)](https://travis-ci.org/shd101wyy/mume)
+
+This library powers:
+
+- [markdown preview enhanced for atom](https://github.com/shd101wyy/markdown-preview-enhanced)
+- [markdown preview enhanced for vscode](https://github.com/shd101wyy/vscode-markdown-preview-enhanced)
+
+and other external projects such as:
+
+- [TechnicalMarkdown](https://github.com/gabyx/TechnicalMarkdown) up to commit 13856d37030483679
+
+## Installation
+
+```sh
+npm install --save @shd101wyy/mume
+```
+
+## Example
+
+```javascript
+// CJS
+const path = require('path');
+const mume = require('@shd101wyy/mume');
+
+// ESM
+// import * as mume from "@shd101wyy/mume"
+
+async function main() {
+  const configPath = path.resolve(os.tmpdir(), '.mume');
+
+  // if no configPath is specified, the default is "~/.config/mume"
+  // but only if the old location (~/.mume) does not exist
+  await mume.init(configPath);
+
+  const engine = new mume.MarkdownEngine({
+    filePath: '/Users/wangyiyi/Desktop/markdown-example/test3.md',
+    config: {
+      configPath: configPath,
+      previewTheme: 'github-light.css',
+      // revealjsTheme: "white.css"
+      codeBlockTheme: 'default.css',
+      printBackground: true,
+      enableScriptExecution: true, // <= for running code chunks
+    },
+  });
+
+  // open in browser
+  await engine.openInBrowser({ runAllCodeChunks: true });
+
+  // html export
+  await engine.htmlExport({ offline: false, runAllCodeChunks: true });
+
+  // chrome (puppeteer) export
+  await engine.chromeExport({ fileType: 'pdf', runAllCodeChunks: true }); // fileType = 'pdf'|'png'|'jpeg'
+
+  // prince export
+  await engine.princeExport({ runAllCodeChunks: true });
+
+  // ebook export
+  await engine.eBookExport({ fileType: 'epub' }); // fileType = 'epub'|'pdf'|'mobi'|'html'
+
+  // pandoc export
+  await engine.pandocExport({ runAllCodeChunks: true });
+
+  // markdown(gfm) export
+  await engine.markdownExport({ runAllCodeChunks: true });
+
+  return process.exit();
+}
+
+main();
+```
+
+## Markdown Engine Configuration
+
+```js
+const config = {
+  // Default config directory; `null` means "~/.config/mume"
+  configPath : null,
+
+  // Enable this option will render markdown by pandoc instead of markdown-it.
+  usePandocParser: false,
+
+  // In Markdown, a single newline character doesn't cause a line break in the generated HTML. In GitHub Flavored Markdown, that is not true. Enable this config option to insert line breaks in rendered HTML for single newlines in Markdown source.
+  breakOnSingleNewLine: true,
+
+  // Enable smartypants and other sweet transforms.
+  enableTypographer: false,
+
+  // Enable conversion of URL-like text to links in the markdown preview.
+  enableLinkify: true,
+
+  // Math
+  mathRenderingOption: "KaTeX",  // "KaTeX" | "MathJax" | "None"
+  mathInlineDelimiters: [["$", "$"], ["\\(", "\\)"]],
+  mathBlockDelimiters: [["$$", "$$"], ["\\[", "\\]"]],
+  mathRenderingOnLineService: "https://latex.codecogs.com/gif.latex", // "https://latex.codecogs.com/svg.latex", "https://latex.codecogs.com/png.latex"
+  mathjaxV3ScriptSrc: 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js',
+
+  // Enable Wiki Link syntax support. More information can be found a  https://help.github.com/articles/adding-links-to-wikis/
+  enableWikiLinkSyntax: true,
+  // If checked, we use GitHub style piped wiki links, i.e. [[linkText|wikiLink]]. Otherwise, we use
+  // [[wikiLink|linkText]] as the original Wikipedia style.
+  useGitHubStylePipedLink: true
+  // By default, the extension for wikilink is `.md`. For example: [[test]] will direct to file path `test.md`.
+  wikiLinkFileExtension: '.md'
+
+  // Enable emoji & font-awesome plugin. This only works for markdown-it parser, but not pandoc parser.
+  enableEmojiSyntax: true
+
+  // Enable extended table syntax to support merging table cells.
+  enableExtendedTableSyntax: false
+
+  // Enable CriticMarkup syntax. Only works with markdown-it parser.
+  // Please check http://criticmarkup.com/users-guide.php for more information.
+  enableCriticMarkupSyntax: false
+
+  // Front matter rendering option
+  frontMatterRenderingOption: 'none', // 'none' | 'table' | 'code block'
+
+  // Mermaid theme
+  mermaidTheme: 'default', // 'default' | 'dark' | 'forest'
+
+  // Code Block theme
+  // If `auto.css` is chosen, then the code block theme that best matches the current preview theme will be picked.
+  codeBlockTheme: 'auto.css',
+  //  "auto.css",
+  //  "default.css",
+  //  "atom-dark.css",
+  //  "atom-light.css",
+  //  "atom-material.css",
+  //  "coy.css",
+  //  "darcula.css",
+  //  "dark.css",
+  //  "funky.css",
+  //  "github.css",
+  //  "hopscotch.css",
+  //  "monokai.css",
+  //  "okaidia.css",
+  //  "one-dark.css",
+  //  "one-light.css",
+  //  "pen-paper-coffee.css",
+  //  "pojoaque.css",
+  //  "solarized-dark.css",
+  //  "solarized-light.css",
+  //  "twilight.css",
+  //  "vue.css",
+  //  "vs.css",
+  //  "xonokai.css"
+
+  // Preview theme
+  previewTheme: 'github-light.css',
+  // "atom-dark.css",
+  // "atom-light.css",
+  // "atom-material.css",
+  // "github-dark.css",
+  // "github-light.css",
+  // "gothic.css",
+  // "medium.css",
+  // "monokai.css",
+  // "newsprint.css",
+  // "night.css",
+  // "none.css",
+  // "one-dark.css",
+  // "one-light.css",
+  // "solarized-dark.css",
+  // "solarized-light.css",
+  // "vue.css"
+
+  // Revealjs presentation theme
+  revealjsTheme: "white.css",
+  // "beige.css",
+  // "black.css",
+  // "blood.css",
+  // "league.css",
+  // "moon.css",
+  // "night.css",
+  // "serif.css",
+  // "simple.css",
+  // "sky.css",
+  // "solarized.css",
+  // "white.css",
+  // "none.css"
+
+  // Accepted protocols for links.
+  protocolsWhiteList: "http://, https://, atom://, file://, mailto:, tel:",
+
+  // When using Image Helper to copy images, by default images will be copied to root image folder path '/assets'
+  imageFolderPath: '/assets',
+
+  // Whether to print background for file export or not. If set to `false`, then `github-light` preview theme will b  used. You can also set `print_background` in front-matter for individual files.
+  printBackground: false,
+
+  // Chrome executable path, which is used for Puppeteer export. Leaving it empty means the path will be found automatically.
+  chromePath: '',
+
+  // ImageMagick command line path. Should be either `magick` or `convert`. Leaving it empty means the path will be found automatically.
+  imageMagickPath: '',
+
+  // Pandoc executable path
+  pandocPath: 'pandoc',
+
+  // Pandoc markdown flavor
+  pandocMarkdownFlavor: "markdown-raw_tex+tex_math_single_backslash",
+
+  // Pandoc arguments e.g. ['--smart', '--filter=/bin/exe']. Please use long argument names.
+  pandocArguments: [],
+
+  // Default latex engine for Pandoc export and latex code chunk.
+  latexEngine: 'pdflatex',
+
+  // Enables executing code chunks and importing javascript files.
+  // This enables also the sidebar table of content.
+  // ⚠ ️ Please use this feature with caution because it may put your security at risk!
+  //    Your machine can get hacked if someone makes you open a markdown with malicious code while script execution is enabled.
+  enableScriptExecution: false,
+
+  // Enables transform audio video link to to html5 embed audio video tags.
+  // Internally it enables markdown-it-html5-embed plugins.
+  enableHTML5Embed: false,
+
+  // Enables video/audio embed with ![]() syntax (default).
+  HTML5EmbedUseImageSyntax: true,
+
+  // Enables video/audio embed with []() syntax.
+  HTML5EmbedUseLinkSyntax: false,
+
+  // When true embed media with http:// schema in URLs. When false ignore and don't embed them.
+  HTML5EmbedIsAllowedHttp: false,
+
+  // HTML attributes to pass to audio tags.
+  HTML5EmbedAudioAttributes: 'controls preload="metadata" width="320"',
+
+  // HTML attributes to pass to video tags.
+  HTML5EmbedVideoAttributes: 'controls preload="metadata" width="320" height="240"',
+
+  // Puppeteer waits for a certain timeout in milliseconds before the document export.
+  puppeteerWaitForTimeout: 0,
+
+  // Args passed to puppeteer.launch({args: $puppeteerArgs})
+  puppeteerArgs: [],
+
+  // Render using PlantUML server instead of binary. Leave it empty to use the plantuml.jar file at `plantumlJarPath` (`java` is required in system path). Eg: "http://localhost:8080/svg/".
+  // You run start a plantuml server by running:
+  // $ docker run -d -p 8080:8080 plantuml/plantuml-server:jetty
+  plantumlServer: "http://localhost:8080/svg/",
+
+  // The absolute of the PlantUML jar file.
+  // The plantuml.jar file could be downloaded from https://sourceforge.net/projects/plantuml/
+  plantumlJarPath: "",
+
+  // Example values:
+  // - cdn.jsdelivr.net
+  // - fastly.jsdelivr.net
+  // - gcore.jsdelivr.net
+  // - testingcf.jsdelivr.net
+  jsdelivrCdnHost: "cdn.jsdelivr.net",
+
+  // Kroki server url.
+  krokiServer: "https://kroki.io",
+}
+
+// Init Engine
+const engine = new mume.MarkdownEngine({
+  filePath: '...',
+  projectDirectoryPath: '...',
+  config: config
+})
+```
+
+## Global Configuration
+
+Global config files are located in the `$XDG_STATE_HOME/mume` directory, which is `~/.config/mume` by default
+
+## Development
+
+[Visual Studio Code](https://code.visualstudio.com/) is recommended.
+Recommended to use Node.js version 20.
+
+1.  Clone this project
+2.  Run `yarn` from shell
+3.  Open in vscode, then `cmd+shift+b` to build
+4.  Run the tests with `yarn test`
+
+Or
+
+If you already have [nix](https://nixos.org/download.html) and [direnv](https://direnv.net/) installed, simply cd to the project directory, then run `direnv allow` once.