Challenge Overview
Challenge Objectives
-
Spark, coded in Javascript
-
This challenge will implement new Markdown parsing functionality in Spark to implement table support and tab navigation
Project Background
-
Sparkdown is a Markdown renderer that targets Spark
-
Spark: http://pxscene.org/
-
Markdown description: https://guides.github.com/features/mastering-markdown/
-
- The existing code is here:
- https://github.com/pxscene/pxCore���
- Javascript files for Markdown are here: https://github.com/pxscene/pxscene/tree/gh-pages/mime
- NOTE: The mime_*.js files in Github are deprecated. Look at the view*.js files instead.
- You may have to host the MIME files locally and update the initialization code to use the local copy instead of the pxscene.org files.
-
Using the macOS application available on pxscene.org, you can drag and drop a markdown file into Spark and it will render as expected. Note that the default build opens a markdown file when first opening as well.
Technology Stack
- The majority of the code for this challenge will be written in Javascript.
- We will target the master branch in Github
Code access
No specific code access is required. The code should be accessible through Github.
Documentation can be found here: https://github.com/pxscene/Spark
Individual requirements
- The main requirements for this challenge can be found here:
Deployment guide and validation document
Make sure to require two separate documents for validation.
A README.md that covers:
- How to deploy and run the modified pxScene version with updated markdown handling (including deploying the updated MIME files locally)
A Validation.md that covers:
-
How to test the new functionality
Validation video / screencast
-
No video is required for this challenge
What To Submit
Please submit the following:
- Patch file for the HEAD of the pxCore Github repo (or a recent commit hash). NOTE: This is only if C++ updates are needed to the Spark app.
- Patch file for the gh_pages branch of the pxscene repo to update the Javascript
- ���README.md
-
Validation.md