Documentation

What's included?

File Structure

First of all, let’s analyze the file and folder structure of reveal, what each file does and why we need it. We love being extremely organized, that’s why we’re following the standards for file and folder organization in web applications.

  • assets All the assets you should add to your website.
    • css Stylesheets related to reveal
      • bootstrap Reveal works perfectly with any CSS Framework, bootstrap is one of them
        • bootstrap.css Bootstrap main stylesheet
      • documentation Documentation related stylesheets
        • documentation.css Documentation main stylesheet
      • icons Icon stylesheets
        • font-awesome-icons.css FontAwesome icons stylesheet
        • pixeden-stroke-icons.css Pixeden Stroke icons stylesheet
        • material-design-icons.css Material Design icons stylesheet
    • fonts Font files in various formats
    • img Image files related to Reveal
      • documentation Images used in the documentation
      • templates Images used inside the templates which you should replace
        • office
        • ufo
    • js Scripts related to reveal
      • animus Animus animation parser scripts
        • presets Animus animation presets
          • default.js Default animation presets pack
        • animus.js Script used for the simple animation syntax
      • bootstrap Bootstrap scripts
      • documentation Documentation script
        • documentation.js Documentation initialization script
      • gsap GSAP animation script
        • easing Smoothen animations with different easings
          • easepack.js Predefined easings
        • plugins GSAP plugins pack
          • css.js Animate CSS properties with GSAP
        • tweenlite.js High performance 3D animations script
      • jquery jQuery script
        • jquery.js Easy DOM element interactions
      • nanoscroller Custom scroll script for documentation
        • nanoscroller.js Enable custom scroll for table of contents sidebar
      • prism Syntax highlighting script for documentation
        • prism.js
      • reveal Reveal required scripts
        • reveal.js Reveal main script
  • src Source code for developers
  • changelog.md Changelog for every version of reveal
  • documentation.html Offline documentation homepage
  • office.html A beautiful office scroll reveal template
  • ufo.html An impressive UFO flying through