Code Monkey home page Code Monkey logo

longform's Introduction

Longform

Provides a new page type in wagtail that allows authors to add content to several newely defined block types within streamfield.

Each longform page created produces both a page that depends on JavaScript, and, a Printable, Accessible, JavaScript-less, lightweight page.

What's required

What's included

  • Blocktype definitions for streamfield
  • Templates, compiled CSS and JS to render both resulting pages

Installation

Authoring content with it

  • The title, introduction and background image make up the Coverblock
  • The menu links populate the primary navigation
  • The related page is added to the Footerblock as a link using the title and introduction properties from the linked page
  • Within the body an author will need to create a chapter providing it with a title, each chapter populates the chapter navigation present on desktop resolutions upwards
  • After creating a chapter users can then chose the section style they would like to use

Developing with it

If you would like to make modifications to the templates;

  • Browse the templates directory and modify the corresponding template

If you would like to adjust the CSS and/or JS;

  • Ensure you have node 4.x or higher (we recommend sticking to LTS releases to ensure module compatibility)
  • Install dependancies, navigate to the /longform directory and run npm install
  • Build and watch source directories with npm run dev

longform's People

Contributors

loque- avatar zerolab avatar

Stargazers

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

Watchers

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

longform's Issues

Reorganise blocks

blocks.py is messy. Put blocks in separate files in a blocks folder.

Add .gitignore

Needs a .gitgnore file to exclude common python / IDE / npm paths and files.

e.g. __pycache__

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.