Giter VIP home page Giter VIP logo

contentascode's Introduction

Content as Code

Content as Code is a partnership which develops workflows and technology to improve content re-use and maintainability.

It is formed of implementers in organisations publishing free/libre and open source content and wanting to have lightweight (post-CMS) approaches to content management that focus on the author experience (as well as editor and translator experience).

Goals

To develop workflows and technology in order to make content authoring and management benefit from software engineering collaboration best practices.

In particular by:

  • Using Git for version control
  • Using Markdown and enhanced flavors of Markdown for authoring
  • Developing better tools focusing on author experience
  • Developing pathways for content contribution and review
  • Enabling translation workflows
  • Support static website generation and interoperability with content management systems
  • Enable content reuse

Roadmap

Reference Implementation

This repo contains the source (master branch) and generated (gh-pages branch) site which is building http://iilab.github.io/contentascode-site

It is a reference implementation for the crump workflow for Github/Github Pages/Prose/Transifex and also depends on:

Other implementations based on self-hosted software Gitlab/Jekyll/Prose will be developed.

Install

  • You might need a ruby version manager (such as rvm)
  • You might need to bundle update

Build

This repo should build automatically on Github Pages. To build the site locally for development:

bundle exec jekyll serve --watch --baseurl ''

You can also run bundle exec jekyll build (to generate the site in /_site) or bundle exec jekyll serve (optionally with the --watch flag to rebuild automatically when a source markdown file changes)

Notes

  • This site was built by reusing the using the Hyde theme.
  • Minor changes were made such as:
    • adding the gems key/values
    • removing the relative_permalinks: true
    • kramdown's auto table of contents
    • adding source and edit links
  • I use this trick to keep the master branch synchronised with the gh-pages branch

contentascode's People

Contributors

jmatsushita avatar

Watchers

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