puckbag / content-only

A content only suggestion for structuring the content storage of a website.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

content-only

This repository represents a suggested guidline for content storage in a website.

There are no assumptions or expectations about how the content within this structure is managed or delivered.

Suggestion

The following is the author's suggestion for structuring and delivering the contained content.

Structure

The author's vision is to structure the content in folders in the following way.

/pages
/parts
/media

/pages

This directory will be used for the hierarchical page structure of the website.

Each file and folder will be accessible via URL in the site implementation, likely mapping the URL directly to the file/folder name.

The file format is not defined but likely choices include MultiMarkdown or perhaps plain HTML.

It will be the delivery application's resposibility to transform this content into a themed and navigable functional site.

/parts

This directory will be used for re-usable and dynamically included parts of content.

Possiblities might include quotes, features, or products.

/media

This directory will be used for storing media assets such as images and videos.

These media assets should be the most original version that could be desired in any delivery of the content.

Applications should be responsible for converting, scaling, or manipulating the media.

Delivery

The author's vision for delivering the content is as follows.

The site instance of this content repository will be maintained in a separate git repository. In the simplest case, contributors will have direct access to the git repository. In the most advanced case, a through-the-web interface will be used to edit content and commit changes to the repository on save or other event.

  • Sitemap generated from complete /pages hierarchy.
  • Meta data within the page files will supplement the output with HTML meta data including <title>, creation date, and open graph content.
  • Primary navigation would be generated from top level pages.
  • Application could assign UUID meta data to the content to preserve permalinks and redirects for re-organization.

Inspirations

  • Markdown/MultiMarkdown
  • Jekyll

About

A content only suggestion for structuring the content storage of a website.

License:MIT License