Giter Site home page Giter Site logo

thruflo

thruflo is a document authoring system. It's still in early, alpha development probably won't work yet if you try to use it.

Problem

  • copying and pasting is inefficient
  • formating is inefficient and introduces brand inconsistencies
  • collaboration by email / locking is limited

Solution

  • write using markdown
  • format using stylesheets
  • reuse sections of previous documents

Implementation

  • web UI as editor
  • don't think just type
  • output
    • documents
    • presentations
    • webpages
    • slideshows
    • emailshots
    • to print
  • formats:
    • pdf
    • html

Reuse

  • use markdown headings to demarcate sections
  • sections stored using <!-- section:${path} --> comment syntax
  • path is human readable, corresponding to ./path/fo/file.md#heading (so it's manually editable by advanced users)
  • section data is denormalised, with the locally cached (i.e.: in the file) version used if the section path fails to resolve

foo.md:

# Foo

## Intro

Lorum ipsum.

## Outro

Dolores dulcit.

bar.md:

# Bar

<!-- section:foo.md#intro -->

## Intro

Lorum ipsum.

<!-- end section -->

## Outro

Glug glug.

Unpinning

  • in the web UI, re-used sections are visually demarcated using bespin syntax highlighting
  • the heading is not editable
  • editing the content saves the original document
  • "unpin" to edit without saving the original (or to edit the heading)
  • this removes the wrapper and just edits the new document directly

James Arthur's Projects

James Arthur doesnโ€™t have any public repositories yet.

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.