Giter VIP home page Giter VIP logo

presdown's Introduction

Project Status: WIP โ€“ Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

presdown

Build an online directory of slides in a way that's friendly to you and continuous integration! You use presdown to generate slides that haven't been generated before or have out of date outputs, incorporating dependencies listed in the DESCRIPTION file and you can even grab the list based on a directory of presentations.

Key functionality is:

  • Use generic render to md for multi-output potential
  • Put images in the correct directories and have references to them that work
  • Refer to a single directory of (generally named) js libraries so that you can manage upgrades to libraries at your discretion
  • Optionally, use pandoc to generate (light) html pages

Anticipated functions:

  • setup_dir(): Create expected directories
  • catalogue_dependencies(): Get dependencies and add to a DESCRIPTION
  • install_presentationjs(): Grab web dependencies (potentially as a git submodule) and install into a static/[presentationlibname]/ dir plus a corresponding pandoc template for use
  • generate_mdfiles(): Identify all presentations with modified dates later than their corresponding md versions and generate them
  • generate_htmlfiles(): Identify all md files with modified dates later than their corresponding html versions and generate them
  • use_build_basic(): Use our boilerplate build script that installs missing dependencies and renders necessary files
  • use_build_git(): Use our boilerplate build script that installs missing dependencies and renders necessary files, then commits changes to git using a [ci skip] prefix
  • use_travis(): Use our boilerplate travis script for using travis to generate your markdown files

Anticipated addins:

  • New presentation for incorporating metadata etc in setup
  • Render process helper

Important considerations:

  • Conforms to (optionally) Hugo/Jekyll expected structures
  • Aimed at incremental CI/CD, not full validation
    • Delete and commit the md files to trigger everything, or exclude them from git generally to always do a build
  • Expects you to be able to manage your javascript dependencies
  • Relies on pandoc template files

presdown's People

Contributors

maelle avatar stephlocke avatar

Stargazers

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

Watchers

 avatar  avatar  avatar

presdown's Issues

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.