Git Product home page Git Product logo

github-pages-demo's Introduction

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

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

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/

github-pages-demo's People

Contributors

dependabot[bot] avatar pme123 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

atry clvnkhr

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.