Giter VIP home page Giter VIP logo

remarkjs_template's Introduction

Presentation about

Add description here.

See this presentation in here.

Presentation Template

This presentation template uses the remarkjs framework. Check it's documentation for basic usage.

This template configures remarkjs to use an external markdown file presentation.md. It also add a few extra css classes, some that can be applied to a slide, some that can be applied to divs and some that can be applied to spans. Check presentation.md, which illustrates the usage of the created classes. It can be seen here.

Below you can find a list of the classes added by this template.

Classes for slides

Remarkjs support adding classes to slides putting class:class1, class2, ... in the beginning of the slide. The classes added by this template that can be added to slides are:

  • inverse, middle, center
  • img-caption -> add to a slide with just a picture and some text
  • hide-slide-number
  • hide-logo
  • overlay-blend -> has an effect only when there is a background image and a background color with "0 < opacity < 1"
  • The classes from animate.css
  • dontanimate -> use in "step" slides if you have animated a slide entrance with animate.css to disable the animation

Classes you can add to spans and divs

  • .moody.labeled.box
  • .moody.alert
  • footnote
  • cite
  • strike
  • extra-top-bottom-margin
  • auto-left-right-margin
  • columns
    • column -> add a column inside the columns
    • Add 'w-10, w-20, ...' class to the same element with the column class for a width proportion
    • Add a 'align-top', ''align-middle' or 'align-middle' class to the column

Debug spacing

Add a debug, debug-white or debug-black class to a slide to help debugging spacing. You can also add one of the debug-grid or debug-grid-16, debug-grid-8-solid or debug-grid-16-solid to add a grid.

Macros

Some remarkjs macros are defined for common things. They are used as ![macroname: arg1, arg2, ...] or ![macroname: arg1, arg2, ...](content). The available macros are

  • box: receives one or two arguments and must have content.
    • The first argument is a class for the box color (moody, happy, angry, or anything else you defined in css.
    • The second argument is an optional box label
  • toc: receives two arguments corresponding to the start/end indexes and has no content.
  • captionedfigure: receives one argument corresponding to the caption and has content (the URL of the image)
  • note: Receives one or two arguments and must have content
    • The note is just a box with a default "Note" label
    • the first argument is a class for the box color (same as the box macro)
    • The second argument is the note label
  • qrcode: has no argument but must have content containing the text to convert to a QR code. The content usually is just a URL.
  • today: has no arguments and no content. It is simply replaced by today's date.

Mathjax

Mathematical equations can be typeset using LaTeX notation and are rendered by MathJax. For display equations use two dollar signs as delimiters like in LaTeX. For inline equations use \$ as delimiter. If you want to change the inline delimiter just modify the js/configure_mathjax.js file.

Some LaTeX macros are defined for easier typing. For instance, a common notation is using boldface lower case for vectors and boldcase uppercase for matrices. A series of vtX and mtX macros are defined for each letter in the alphabet (as well as some Greek letters). For instance, instead of typing \mathbf{y} to write a y vector, we can use \vtY. a a Y matrix we can use \mtY. Similar macros are defined for sets (which are written as \stX and replaced by \mathcal{X}) and blackboard letters (which are written as \bbX and replaced by \mathbb{X}).

Creating figures programmatically

  • Using TikZ in a browser like MathJax
    • See this link
    • It works in your machine, but it won't work in github pages, for instance
  • MathJax and d3
  • Convert a PDF created with tikz into an SVG file
    • This will always work
  • Using a webservice that converts tex code into an image and gives you the link to use
    • See this link
    • It is basically the same as you converting yourself from a PDF generated with tikz into SVG
  • Other people also want some way to create draws that can use mathjax for equations
    • See
  • mathbox seems like a good candidate to replace tikz and allows rendering the equations

TODO: Investigate jsxgraph

remarkjs_template's People

Contributors

darcamo avatar

Watchers

 avatar  avatar

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.