Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fboes committed Jan 18, 2018
1 parent 86b4634 commit 9289b9c
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 440 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ A live example of this blog generator can be found at [3960! Journal](http://jou
* The Blogophon generates static HTML files from [Markdown articles](docs/markdown.md). These HTML files can be synchronized to remote servers and are fully independent of the Blogophon generator.
* It uses simple, fast and [hackable templating](docs/development.md) via Mustache. It also supports multiple themes.
* Generates a bunch of way to find your articles: Regular index pages, tag pages, author pages.
* The Blogophon comes with a built-in image-scaler, which leads to responsive images.
* The Blogophon comes with a built-in image-scaler for responsive images.
* The default theme puts all relevant meta stuff into `<head>` for SEO and social sharing (via schema.org and OpenGraph).
* A ton of [special features](docs/special-features.md) like RSS/ATOM newsfeeds, Accelerated Mobile Pages (AMP), Facebook Instant Articles, etc.

Requirements
------------

Your _blog pages_ can be hosted on any web hosting service - it only consists of static files. You will need no PHP, MySQL or anything like that.
The _Blogophon generator_ works on every platform with [NodeJs](https://nodejs.org/en/). This includes Windows, Mac OSX and Linux. The Blogophon can also be installed directly on your web host, as long as you have [NodeJs](https://nodejs.org/en/) installed on your web host and SSH access. The Blogophon generators generates your blog pages.

The Blogophon _generator_ works on every platform with [NodeJs](https://nodejs.org/en/). This includes Windows, Mac OSX and Linux. The Blogophon can also be installed directly on your web host, as long as you have [NodeJs](https://nodejs.org/en/) installed on your web host and SSH access.
Your _blog pages_ can be hosted on any web hosting service - it only consists of static files. You will need no PHP, MySQL or anything like that.

Installation
------------

1. Make sure you have [Node.js](https://nodejs.org/) with at least version 6 installed by calling `node -v`.
1. Make sure you have [ImageMagick](http://www.imagemagick.org/) installed by calling `magick -help`. ImageMagick is needed for scaling images.
1. Run `npm install -g blogophon` to install the Blogophon. If you do not have Node version 6 but at least Node version 4, install an older version of the Blogophon by calling `npm install -g [email protected]`.
1. Make sure you have [Node.js](https://nodejs.org/) with at least version 6 installed. Call `node -v` to see your current version.
1. Make sure you have [ImageMagick](http://www.imagemagick.org/) installed. Call `magick -version` to see your current version. ImageMagick is needed for scaling images.
1. Run `npm install -g blogophon` to install the Blogophon. If you do not have Node version 6 but at least Node version 4, install Blogophon 1.3.0 by calling `npm install -g [email protected]`.
1. Change to a folder you want to initialize a Blogophon blog project in.
1. Run `blogophon` to start the configuration dialogue and enable [special features](docs/special-features.md).
1. Set your web server's document root folder to `htdocs` of your Blogophon blog project (as this will be the folder where the HTML files will be generated by the Blogophon Generator).
Expand Down
Loading

0 comments on commit 9289b9c

Please sign in to comment.