Git Product home page Git Product logo

entwine's Introduction

Entwine

Entwine lets you play through interactive stories told via Markdown documents. It's little more than a viewer for Markdown documents, but one that lets you browse them in style, in an animated way designed for interactive storytelling.

What is Markdown?

Markdown is a simple language for plain text that practically eliminates the need for mouse interaction and makes it super easy to format content. Using common symbols like # and -, you can create neatly formatted documents with ease.

Markdown Example

Maybe an example will help. To create a list item in Markdown, just type a - symbol and a space followed by your content.

For example, type this to create a list item:
- Discuss new features.

How Entwine Works

Entwine is really just a viewer for Markdown documents, such as this one. This document is just a Markdown formatted file with a bunch of headers and anchor links pointing to those headers. A Markdown document reader lets you click links to go to those headers. That's really all Entwine does.

Designed for Elegance

Any Markdown viewer can be used to progress through documents. So why use Entwine?

Entwine is designed for interactive storytelling. In general, it displays content on an as-needed basis, letting you progress through an elegant interface that can be configured for the story being told.

Configurable

Entwine is fully themable/skinnable using CSS. There are also a bunch of pre-made themes to learn from or just use as needed. The project is built for GitHub Pages, where modifications are as easy as possible. Just create a fork of the project and you'll have a ready-made site to configure however you need.

GitHub and GitHub Pages

GitHub is a developer focused code-hosting platform. GitHub Pages lets you host code for HTML websites at no cost. With that, you can host your own Entwine-driven website for free.

Themes

Entwine is part of a set of core projects (BreakDown framework) utilizing the same themes so it's able to use those existing themes. Check out the themes using the CSS Theme selector in the info panel. Or find out more from the link below.

Example CSS Themes

The following are some of the avaialable themes as examples of what is possible:

Entwine ๐Ÿ…‘-nav

โ“˜ The code below designates a list of content sources the user will be able to select from in the app.

content ๐Ÿ…‘-datalist

Appearance ๐Ÿ…‘-collapsible

css ๐Ÿ…‘-datalist

๐Ÿ…‘-theme-variables

Effects ๐Ÿ…‘-collapsible

vignette-blend ๐Ÿ…‘-select

vignette ๐Ÿ…‘-slider="0.25,0,1,0.025"

svg-filter ๐Ÿ…‘-select

  • *None

brightness ๐Ÿ…‘-slider="1,0,3,0.05" contrast ๐Ÿ…‘-slider="100%,0,300,1,%" grayscale ๐Ÿ…‘-slider="0%,0,100,1,%" hue-rotate ๐Ÿ…‘-slider="0deg,0,360,1,deg" invert ๐Ÿ…‘-slider="0%,0,100,1,%" saturate ๐Ÿ…‘-slider="100%,0,300,1,%" sepia ๐Ÿ…‘-slider="0%,0,100,1,%" blur ๐Ÿ…‘-slider="0px,0,20,1,px"

Perspective ๐Ÿ…‘-collapsible

scale ๐Ÿ…‘-slider="0,1,5,0.1" perspective ๐Ÿ…‘-slider="1500px,0,2000,1,px" originx ๐Ÿ…‘-slider="50%,0,100,1,%" originy ๐Ÿ…‘-slider="50%,0,100,1,%" rotatex ๐Ÿ…‘-slider="0deg,0,360,1,deg" rotatey ๐Ÿ…‘-slider="0deg,0,360,1,deg" scalez ๐Ÿ…‘-slider="0,1,5,0.1" rotatez ๐Ÿ…‘-slider="0deg,0,360,1,deg" translatez ๐Ÿ…‘-slider="0px,-500,500,1,px"

Dimensions ๐Ÿ…‘-collapsible

width ๐Ÿ…‘-slider="960px,4,4000,1,px" height ๐Ÿ…‘-slider="400px,4,2000,1,px" padding ๐Ÿ…‘-slider="10px,0,500,1,px" inner-space ๐Ÿ…‘-slider="100px,0,300,1,px" outer-space ๐Ÿ…‘-slider="0px,0,300,1,px" offsetx ๐Ÿ…‘-slider="0px,-4000,4000,1,px" offsety ๐Ÿ…‘-slider="0px,-4000,4000,1,px"

Contents ๐Ÿ…‘-collapsible

๐Ÿ…‘-toc

Help ๐Ÿ…‘-group

๐Ÿ…‘-help ๐Ÿ…‘-hide

entwine's People

Contributors

r3v1z3 avatar

Stargazers

 avatar

Watchers

 avatar James Cloos 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.