https://github.com/fboes/blogophon
:trumpet: A Static Site Generator supporting Markdown, responsive images, RSS and other RESTable files. Built with Node.js and minimal dependencies.
https://github.com/fboes/blogophon
cli hackable markdown nodejs npm static-site-generator
Last synced: 12 months ago
JSON representation
:trumpet: A Static Site Generator supporting Markdown, responsive images, RSS and other RESTable files. Built with Node.js and minimal dependencies.
- Host: GitHub
- URL: https://github.com/fboes/blogophon
- Owner: fboes
- License: mit
- Created: 2016-08-01T09:00:16.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T05:34:45.000Z (over 3 years ago)
- Last Synced: 2025-03-24T18:11:20.276Z (12 months ago)
- Topics: cli, hackable, markdown, nodejs, npm, static-site-generator
- Language: JavaScript
- Homepage:
- Size: 2.77 MB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
 Blogophon
=========
A [Static Site Generator](https://davidwalsh.name/introduction-static-site-generators) supporting [Markdown](docs/markdown.md), [responsive images](docs/markdown.md#images), [RSS and other RESTful files](docs/special-features.md). Built with Node.js and minimal dependencies.
A live example of this blog generator can be found at [3960! Journal](http://journal.3960.org).
**Features**
* 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 ways to find your articles: Regular index pages, tag pages, author pages.
* The Blogophon comes with a built-in image-scaler for responsive images.
* The default theme puts all relevant meta stuff into `` for SEO and social sharing (via schema.org and OpenGraph) as well as the [IndieWeb](https://indieweb.org/).
* A ton of [special features](docs/special-features.md) like RSS/ATOM newsfeeds, Accelerated Mobile Pages (AMP), Progressive Web App (PWA), Facebook Instant Articles, sending Webmentions, Gopher-support etc.
* As the Blogophon only consists of static pages, there is no personal data (cookies, etc.) aggregated by your blog - therefore it is easy to comply with any form of privacy protection law (like the [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation)).
Requirements
------------
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.
Your _generated blog pages_ are independent of the Blogophon software, and 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. 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 blogophon@v1.3.0`.
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).
How it works
------------
Just call `blogophon` to open the Blogophon command menu in the folder you are in. There you will be able to create, edit, generate and publish Markdown articles.
The basic work-flow is this:
1. Create a Markdown article (see [Blogophon's Markdown reference](docs/markdown.md) on details).
2. Generate HTML files from your Markdown article via the Blogophon generator.
3. Optional: Publish your HTML files to a remote server.
If you are a CLI wizard, you may also want to take a look at [Blogophon's special CLI features](docs/advanced-stuff.md).
Update
------
1. To find out if your Blogophon needs updating, run `npm outdated -g blogophon`.
2. Run `npm update -g blogophon` to update your local Blogophon installation to the latest stable release.
Feedback
--------
In case of issues or suggestions for the Blogophon consider using [Blogophon's issue board](https://github.com/fboes/blogophon/issues).
Status
-------
[](https://badge.fury.io/js/blogophon)
[](https://travis-ci.org/fboes/blogophon)
[](https://david-dm.org/fboes/blogophon)
[](https://david-dm.org/fboes/blogophon?type=dev)
Legal stuff
-----------
Author: [Frank Boës](https://3960.org)
Copyright & license: See [LICENSE.txt](LICENSE.txt)