Git Product home page Git Product logo

angular-showoff's Introduction

angular-showoff

A presentation tool similar to Scott Chacon's Showoff, but built with AngularJS. As with ShowOff, you write the presentation slides in markdown syntax. But there is no server part, the tool is just a full client web application.

If you want to use it with Chrome, you must run a web server (Node.js for instance) to serve the files, as Chrome doesn't allow scripts in a local HTML page to make HTTP requests. Or you can start Chrome with --allow-file-access-from-files flag to disable this restriction. Firefox has no such restriction.

This application uses the markdown parser named marked, from Christopher Jeffrey. It also uses google-code-prettify for syntax highlighting of source code.

Demo is here. Use 'h' key for help.

Usage

angular-showoff needs a data/config.json config file, which defines the presentation title, and the list of slides files. Here is the sample data/config.json file :

{
    "title": "angular-showoff demo",
    "sections": [
        {"file": "data/begin/begin.md"},
        {"file": "data/end/end.md"}
    ]
}

This example loads two markdown files, containing the slides. Images referenced in the markdown files will be loaded from the same directory as the markdown file. For instance, path data/begin will be used for images in data/begin/begin.md.

As with ShowOff, you may assemble a presentation from several parts. But there is no automatic discovery of markdown files in subdirectories, you have to list all the markdown files in the config file.

The tool can show text, images, syntax highlighted code, bullet or numbered lists. It does not have transitions, nor incremental lists.

The file css/custom.css is for user-defined styles, specific to its presentations.

angular-showoff's People

Contributors

tchatel avatar

Watchers

 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.