README.md

GitHub of Arkivum.docpad

made from YUI Purecss skeleton for DocPad.

Modules

Arkivum.com uses the following DocPad plugins:

• docpad-plugin-cleanurls
• docpad-plugin-coffeescript
• docpad-plugin-eco
• docpad-plugin-marked
• docpad-plugin-partials
• docpad-plugin-text
• docpad-plugin-ghpages
• docpad-plugin-iconmonstr
• docpad-plugin-sitemap
• docpad-plugin-menu - Customized in plugins folder

and the moment.js module.

Getting Started

1. Install Node.js (includes NPM with install)

2. Install DocPad

3. Clone the project and run the server

   git clone git://github.com/MassDistributionMedia/arkivum.docpad.git
   cd arkivum.docpad
   npm install
   docpad run

4. Open http://localhost:9778/ locally in a internet browser. We recommend Google Chrome or Mozilla Firefox.

5. Start hacking away by modifying the src directory

Theming

Skeleton Origin

As mentioned above arkivum.docpad was sculpted from the YUI Purecss DocPad skeleton.

Default template

All pages use the default page template found via the following path: arkivum.docpad/src/layouts/default.html.eco.

For example the "post" page template's meta data uses the default theme as below:

---
layout: default
---

The default template makes up the header, footer and containing structure for the sidebar partials and inner @content.

Sidebar partials

Both the left and right sidebars are their own partials, left-sidebar.html.eco & right-sidebar.html.eco

Layout Breakdown

Images

All images are SVGs excluding only the header/footer background images and the 100% Guaranteed image which are located at src/files/images. Arkivum header and stamp logos are stored as SVG code in partials at src/partials:

• arkivum-logo.html
• arkivum-A-stamp.html

The blue checkmark SVGs are as a svg file at src/files/images/check-6-blue-icon.svg. The remainder of the SVG icons such as the social or contact icons originate from the iconmonstr DocPad plugin.

Fonts

arkivum.docpad uses the family of Din Pro fonts as per Arkivum's branding. These are located at src/files/fonts.

UK Privacy Compliance

CookieConsent works by detecting a cookie containing the user's consent choice. Due to inconsistency problems with detection, a timer (in right-sidebar.html.eco) was added to manually detect the cookie. YouTube video, LeadForensics, Google Analytics, ShareThis are all linked to CookieConsent. Also modified the ShareThis and LeadForensics scripts in order to comply with UK privacy laws by implementing async loading.

Event of the Week

See Issue #2.

Sidebar Menu UX

See Issue #4.

How to handle common errors

Latest DocPad version is failing

1. Delete the /node_modules folder.
2. In package.json set the DocPad dependency to the last known safe/working version.
3. Run the command npm install then docpad run.

I'm getting EMFILE errors

See here for the reason why and the solution

License

Copyright 2013 Arkivum. All rights reserved.