Goals

• Use Github Pages for simple Projects/ Show-cases, that I could document and demo in the same place.

• Use Scala/ ScalaJS technology.

• Use Markup for documentation.

• Create simple Tutorials that:

  • print Mathematical formulas nicely
  • use Graphs for illustration
  • can interacted with
  • display code snippets

Examples

How to use this project

Compile Mathematical Expressions

Extended How-To Example

It's in german and shows a bit more of composition with Binding.scala

And more....

Result

The result is a showcase on how to use different Scala/ ScalaJS tools in combination with Markup and Github Pages (check the references below).

See yourself: https://pme123.github.io/github-pages-demo/

References

This project uses the following tools. All of them have excellent tutorials:

Markup

• Github Pages: When you commit your project to Github your pages will be created automatically. Check out Github Pages
• Jekyll: Github Pages uses Jekyll for rendering. See Jekyll
• So Simple: Michael Rose creates great Themes for Jekyll - so I choose So Simple for this project. Check out its great tutorial: So Simple Theme

Coding

For any coding I use:

• ScalaJS for general coding: ScalaJS
• Binding.scala for dom functionality and data binding: Binding.scala
• ScalablyTyped for JavaScript facades: Scalably Typed
• Plot.ly for painting diagrams and graphs: Plotly JS
• Math.js for evaluating mathematical string expressions: MathJS
• MathJax for printing nice formulas in HTML: MathJax
• Semantic-UI styling the forms (if the theme was not enough): Semantic UI

Building

• sbt for building the project: SBT
• scalajs-bundler for bundling the JavaScript dependencies: scalajs-bundler

Check also

If you want document everything in Scala check out: https://sake92.github.io/hepek/