Mystjs

.eslintrc.json

@@ -20,20 +20,11 @@
   "parserOptions": {
     "ecmaVersion": 2018,
     "sourceType": "module",
-    "project": [
-      "./tsconfig.json"
-    ]
+    "project": ["./tsconfig.json"]
   },
-  "plugins": [
-    "@typescript-eslint",
-    "no-skip-tests",
-    "no-only-tests"
-  ],
+  "plugins": ["@typescript-eslint", "no-skip-tests", "no-only-tests"],
   "rules": {
-    "quotes": [
-      "error",
-      "single"
-    ],
+    "quotes": ["error", "single"],
     "prettier/prettier": [
       "error",
       {
@@ -43,17 +34,15 @@
     ],
     "import/prefer-default-export": "off",
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/camelcase": "off"
+    "@typescript-eslint/camelcase": "off",
+    "jest/no-export": "off",
+    "jest/valid-title": "off"
   },
   "settings": {
     "import/resolver": {
       "node": {
-        "extensions": [
-          ".js",
-          ".ts",
-          ".spec.ts"
-        ]
+        "extensions": [".js", ".ts", ".spec.ts"]
       }
     }
   }
-}
+}

.github/workflows/lint_and_unittests.yml

@@ -2,65 +2,50 @@ name: CI
 
 on:
   push:
-    branches: [ main, ci-* ]
+    branches: [main, ci-*]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Cache packages
-      id: cache-npm
-      uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-npm-${{ hashFiles('**/yarn.lock') }}
-        restore-keys:
-          ${{ runner.os }}-npm-
-    - name: Use Node.js 12.x
-      uses: actions/setup-node@v1
-      with:
-        node-version: 12.x
-    - name: install dependencies
-      run: |
-        yarn install
-    - name: lint
-      run: |
-        yarn run lint
+      - uses: actions/checkout@v2
+      - name: Cache packages
+        id: cache-npm
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: ${{ runner.os }}-npm
+      - name: Use Node.js 12.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+      - run: npm install
+      - run: npm run lint
 
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [12.x, 14.x]
-
     steps:
-    - uses: actions/checkout@v2
-    - name: Cache packages
-      id: cache-npm
-      uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-npm-${{ hashFiles('**/yarn.lock') }}
-        restore-keys:
-          ${{ runner.os }}-npm-
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-
-    - name: install dependencies
-      run: |
-        yarn install
-
-    - name: Run the tests and generate coverage reportst
-      run: |
-        yarn test --coverage
-
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1
-
-    - name: Run the build
-      run: yarn run build
+      - uses: actions/checkout@v2
+      - name: Cache packages
+        id: cache-npm
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: ${{ runner.os }}-npm
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - name: Run the tests and generate coverage reportst
+        run: npm run test --coverage
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+      - run: npm run build

.gitignore

@@ -2,3 +2,8 @@ dist/
 node_modules/
 docs/_build/*
 coverage/
+.yalc/*
+yalc.lock
+
+# The following is built for the docs
+docs/_static/myst.min.js

.prettierignore

@@ -0,0 +1 @@
+tests/*.md

.prettierrc

@@ -1,7 +1,5 @@
 {
   "singleQuote": true,
-  "trailingComma": "none",
-  "arrowParens": "avoid",
-  "semi": false,
+  "trailingComma": "all",
   "printWidth": 88
 }

README.md

@@ -1,28 +1,31 @@
-# markdown-it-myst
-[![markdown-it-myst on npm](https://img.shields.io/npm/v/markdown-it-myst.svg)](https://www.npmjs.com/package/markdown-it-myst)
-[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/executablebooks/markdown-it-myst/blob/master/LICENSE)
-[![CI](https://github.com/executablebooks/markdown-it-myst/workflows/CI/badge.svg)](https://github.com/executablebooks/markdown-it-myst/actions)
-[![docs](https://github.com/executablebooks/markdown-it-myst/workflows/docs/badge.svg)](https://executablebooks.github.io/markdown-it-myst)
-[![demo](https://img.shields.io/badge/live-demo-blue)](https://executablebooks.github.io/markdown-it-myst/demo/index.html)
+# mystjs
 
-> :warning: **Note:** `markdown-it-myst` is alpha, expect changes! (January, 2021)
+[![mystjs on npm](https://img.shields.io/npm/v/mystjs.svg)](https://www.npmjs.com/package/mystjs)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/executablebooks/mystjs/blob/master/LICENSE)
+[![CI](https://github.com/executablebooks/mystjs/workflows/CI/badge.svg)](https://github.com/executablebooks/mystjs/actions)
+[![docs](https://github.com/executablebooks/mystjs/workflows/docs/badge.svg)](https://executablebooks.github.io/mystjs)
+[![demo](https://img.shields.io/badge/live-demo-blue)](https://executablebooks.github.io/mystjs/demo/index.html)
+
+> :warning: **Note:** `mystjs` is alpha, expect changes! (January, 2021)
 
 A javascript parser for [MyST](https://myst-parser.readthedocs.io) based on [markdown-it](https://github.com/markdown-it/markdown-it)
 
 ## Goals
-* Provide a Javascript implementation of [MyST](https://myst-parser.readthedocs.io) markdown extensions
-  * Uses standard html for all known roles and directives, with no styling enforced or provided
-* Provide functionality for cross-referencing that is usually completed by Sphinx (e.g. in the [Python implementation](https://github.com/executablebooks/MyST-Parser))
+
+- Provide a Javascript implementation of [MyST](https://myst-parser.readthedocs.io) markdown extensions
+  - Uses standard html for all known roles and directives, with no styling enforced or provided
+- Provide functionality for cross-referencing that is usually completed by Sphinx (e.g. in the [Python implementation](https://github.com/executablebooks/MyST-Parser))
 
 ## Usage
 
 ```bash
-npm install markdown-it-myst
+npm install mystjs
 ```
 
 In a node environment:
+
 ```javascript
-import { MyST } from 'markdown-it-myst';
+import { MyST } from 'mystjs';
 
 const myst = MyST();
 const html = myst.render('# Hello to the world!');
@@ -32,46 +35,98 @@ console.log(html);
 ```
 
 In a browser:
+
 ```html
 <html>
-<head>
-  <script src="https://unpkg.com/markdown-it-myst"></script>
-</head>
-<body onload="init();">
-  <div id="output"></div>
-  <script>
-    function init() {
-      const myst = MyST();
-      const html = myst.render('# Hello to the world!');
-      document.getElementById('output').innerHTML = html;
-    }
-  </script>
-</body>
+  <head>
+    <script src="https://unpkg.com/mystjs"></script>
+  </head>
+  <body onload="init();">
+    <div id="output"></div>
+    <script>
+      function init() {
+        const myst = MyST();
+        const html = myst.render('# Hello to the world!');
+        document.getElementById('output').innerHTML = html;
+      }
+    </script>
+  </body>
 </html>
 ```
 
+## `mystjs` Features
+
+- CommonMark
+- Admonitions
+- Figures
+- Images
+- Math
+  - role
+  - directive (equations)
+  - dollar
+  - amsmath
+- Tables
+  - GFM
+  - List Tables
+- References
+  - ref
+  - numref
+  - eq
+  - links
+  - Including numbering (single document)
+- Citations (parse only)
+- Code Directives
+  - Code
+  - Code blocks
+  - Code cell
+- Blocks
+- Comments
+- Targets
+- HTML: sub, sup, abbr
+- Definition List
+- Footnotes
+
+Not yet complete:
+
+- div
+- proof
+- margin
+- sidebar
+- colon fence
+- Bibliography
+- Epigraph
+- Glosary
+- Terms
+- Tabs
+- Panels
+- CSV Tables
+- Multi-document
+
 ## Developer Install
 
-For installing the package locally, we suggest [Yarn](https://yarnpkg.com/), which can be installed using these [instructions](https://yarnpkg.com/getting-started/install), you will need [node](https://nodejs.org/), both can use a global install on your system.
+For installing the package locally, you will need [node](https://nodejs.org/) and [npm](https://docs.npmjs.com/about-npm), both can use a global install on your system.
 
-Once you have `yarn` installed globally, navigate into this project folder and install the dependencies:
+Once you have `npm` installed globally, navigate into this project folder and install the dependencies:
 
 ```bash
-cd markdown-it-myst
-yarn install
-yarn start  # Start a development server to play with the library! 🚀
+cd mystjs
+npm install
+npm run start  # Start a development server to play with the library! 🚀
 ```
 
 The scripts for building, testing, and serving the project are in the [package.json](package.json), the main ones to use are
-`yarn test`, `yarn build`, and `yarn start`.
+`npm run test`, `npm run build`, and `npm run start`.
+
+### `npm run build`
 
-### `yarn build`
-Builds the library, including compiling the typescript and bundling/minification to create `myst.min.js`.
+Builds the library, including compiling the typescript and bundling/minification to create `index.umd.min.js`.
 This outputs to the `dist` folder, and also includes all type definitions (`*.d.ts`).
 
-### `yarn test`
-Run the tests, these are mostly based on the [fixtures](fixtures) folder. You can also use `yarn test:watch` to run on any file changes.
+### `npm run test`
+
+Run the tests, these are mostly based on the [fixtures](fixtures) folder. You can also use `npm run test:watch` to run on any file changes.
+
+### `npm run start`
 
-### `yarn start`
-Starts a server for manually testing and playing with `markdown-it-myst`, this uses a in-memory bundle of what would go in the `dist` folder.
+Starts a server for manually testing and playing with `mystjs`, this uses a in-memory bundle of what would go in the `dist` folder.
 Note that this does not actually build the library!

docs/Makefile

@@ -1,12 +1,21 @@
 .PHONY: build serve watch
 
 build:
+	cd ..; npm run build
 	jupyter-book build .
-	rm -r _build/html/dist | true;
+	rm -r _build/html/demo | true;
 	cp -r ../dist _build/html/demo
+	cp ../dist/index.umd.min.js _static/myst.min.js
+	sed -i '' "s/NAVIGATION_WITH_KEYS: true/NAVIGATION_WITH_KEYS: false/g" _build/html/_static/documentation_options.js
 
-watch:
-	nodemon -w './**' -e yml,md,ipynb --exec jupyter-book build .
+build-watch:
+	jupyter-book build .
+	cp ../dist/index.umd.min.js _build/html/_static/myst.min.js
+	sed -i '' "s/NAVIGATION_WITH_KEYS: true/NAVIGATION_WITH_KEYS: false/g" _build/html/_static/documentation_options.js
+
+watch: clean
+	make build
+	nodemon -w './**' --ignore _build/ -e yml,md,ipynb,js --exec make build-watch
 
 serve:
 	cd _build/html; python -m http.server 9000