Git Product home page Git Product logo

gifs-as-documentation's Introduction

gifs-as-documentation

The theory and practice of animated GIFs as documentation.

If you want to read this guide, check it out on Read the Docs. If you want more information on building or contributing to this guide, please continue reading this file.

Author

GIFs as Documentation was written by Daniel D. Beck (@ddbeck). Suggestions for additional content were provided the participants of the GIFs in Docs unconference session at Write the Docs 2015.

License

GIFs as Documentation is licensed under a Creative Commons Attribution 4.0 International License. The full text of the license can be found in the LICENSE file.

gifs-as-documentation's People

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

gifs-as-documentation's Issues

Update the README file

The cobbler's children have no shoes. I need to add some useful information to the README, such as:

  • Link to the fully built, hosted documentation (pending some kind of resolution to issue #2)
  • Local build directions (i.e., install dependencies and run make html)
  • Author(s) information
  • License information (pending issue #1)

Gif in sphinx doc with play button?

There seem to be a few javascript libraries that let you have animated gifs with a play button, so they don't play immediately.

Is there a way of using something like this with sphinx-docs?

Update the guide based on Write the Docs unconference session

On Monday, May 18, I held a GIFs in Documentation unconference session at Write the Docs. I learned some new tools and ideas and which should be reflected in the guide:

  • Add link to GIF Brewery
  • Add suggestion for some kind of progress indicator (like a red line)
  • Add information about play-on-mouseover
  • Add mention of Slack, IRC, etc. as potential use for GIFs
  • Investigate Monosnap tool (not sure how this applies to GIFs)
  • Suggest GIMP for editing GIFs

Rehost on Read the Docs

I should rehost these docs on RtD, instead of gh-pages, so I don't have to build them myself. This repo is configured on Read the Docs, but it fails to build because you can't put GIFs in Sphinx PDFs. Fixing Read the Docs issue #1154 is the "right" way to fix this, but in the meantime I should nest all the .. figure:: directives inside .. only:: html directives so Read the Docs won't complain.

Add a license file

I need to add a license file. It should be something fairly permissive, like CC-BY.

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.