https://github.com/alisdair/maximum

Software for building the weblog I want to write
https://github.com/alisdair/maximum

Last synced: 10 days ago
JSON representation

Software for building the weblog I want to write

• Host: GitHub
• URL: https://github.com/alisdair/maximum
• Owner: alisdair
• Created: 2015-08-03T20:02:45.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T20:27:45.000Z (about 2 months ago)
• Last Synced: 2024-10-12T20:57:57.860Z (24 days ago)
• Language: JavaScript
• Homepage: https://alisdair.mcdiarmid.org/
• Size: 1.99 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Maximum

[![Build Status](https://travis-ci.org/alisdair/maximum.svg)](https://travis-ci.org/alisdair/maximum)

Software for building the weblog I want to write. Supports writing [posts which include interactive demos with SVGs](http://alisdair.mcdiarmid.org/arm-immediate-value-encoding/):

- Per-post CSS and JavaScript, written in separate files

- Embed partials at the end of posts

- Configurable per-post Handlebars layouts

- Arbitrary JSON data for each post, which can be used by the JavaScript or the layout

Also has some other more common features:

- Write in GitHub-flavoured Markdown, with fenced code blocks and decent syntax highlighting

- Sass and autoprefixer for CSS generation

- CSS minified then embedded into the HTML, to reduce render time

- Depends only on Node, with Node scripts for build, local serve, and deploy

## Usage

1. `npm install`

2. `npm start`

3. Optionally, in another terminal, `npm run watch` to rebuild when files change

## New Post

1. `npm run new`

2. Edit the generated data.json and index.md files

3. Add other supporting files in the same directory as required

## Deployment

1. `npm config set alisdair.mcdiarmid.org:server user@rsynchost:path-with-trailing-slash/`

2. `npm run deploy`