{"id":20244009,"url":"https://github.com/fboes/blogophon","last_synced_at":"2025-04-10T20:33:25.853Z","repository":{"id":10149905,"uuid":"64652076","full_name":"fboes/blogophon","owner":"fboes","description":":trumpet: A Static Site Generator supporting Markdown, responsive images, RSS and other RESTable files. Built with Node.js and minimal dependencies.","archived":false,"fork":false,"pushed_at":"2022-12-08T05:34:45.000Z","size":2903,"stargazers_count":8,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-24T18:11:20.276Z","etag":null,"topics":["cli","hackable","markdown","nodejs","npm","static-site-generator"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fboes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-01T09:00:16.000Z","updated_at":"2024-12-22T13:17:04.000Z","dependencies_parsed_at":"2023-01-11T20:14:11.037Z","dependency_job_id":null,"html_url":"https://github.com/fboes/blogophon","commit_stats":null,"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fboes%2Fblogophon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fboes%2Fblogophon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fboes%2Fblogophon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fboes%2Fblogophon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fboes","download_url":"https://codeload.github.com/fboes/blogophon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248290042,"owners_count":21078923,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","hackable","markdown","nodejs","npm","static-site-generator"],"created_at":"2024-11-14T09:11:12.870Z","updated_at":"2025-04-10T20:33:25.828Z","avatar_url":"https://github.com/fboes.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![](docs/blogophon.png) Blogophon\n=========\n\nA [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.\n\nA live example of this blog generator can be found at [3960! Journal](http://journal.3960.org).\n\n**Features**\n\n* 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.\n* It uses simple, fast and [hackable templating](docs/development.md) via Mustache. It also supports multiple themes.\n* Generates a bunch of ways to find your articles: Regular index pages, tag pages, author pages.\n* The Blogophon comes with a built-in image-scaler for responsive images.\n* The default theme puts all relevant meta stuff into `\u003chead\u003e` for SEO and social sharing (via schema.org and OpenGraph) as well as the [IndieWeb](https://indieweb.org/).\n* 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.\n* 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)).\n\nRequirements\n------------\n\nThe _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.\n\nYour _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.\n\nInstallation\n------------\n\n1. Make sure you have [Node.js](https://nodejs.org/) with at least version 6 installed. Call `node -v` to see your current version.\n1. Make sure you have [ImageMagick](http://www.imagemagick.org/) installed. Call `magick -version` to see your current version. ImageMagick is needed for scaling images.\n1. 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`.\n1. Change to a folder you want to initialize a Blogophon blog project in.\n1. Run `blogophon` to start the configuration dialogue and enable [special features](docs/special-features.md).\n1. 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).\n\nHow it works\n------------\n\nJust 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.\n\nThe basic work-flow is this:\n\n1. Create a Markdown article (see [Blogophon's Markdown reference](docs/markdown.md) on details).\n2. Generate HTML files from your Markdown article via the Blogophon generator.\n3. Optional: Publish your HTML files to a remote server.\n\n![The main menu in action.](docs/example.png)\n\nIf you are a CLI wizard, you may also want to take a look at [Blogophon's special CLI features](docs/advanced-stuff.md).\n\nUpdate\n------\n\n1. To find out if your Blogophon needs updating, run `npm outdated -g blogophon`.\n2. Run `npm update -g blogophon` to update your local Blogophon installation to the latest stable release.\n\nFeedback\n--------\n\nIn case of issues or suggestions for the Blogophon consider using [Blogophon's issue board](https://github.com/fboes/blogophon/issues).\n\nStatus\n-------\n\n[![npm version](https://badge.fury.io/js/blogophon.svg)](https://badge.fury.io/js/blogophon)\n[![Build Status](https://travis-ci.org/fboes/blogophon.svg?branch=master)](https://travis-ci.org/fboes/blogophon)\n[![Dependency Status](https://david-dm.org/fboes/blogophon/status.svg)](https://david-dm.org/fboes/blogophon)\n[![devDependency Status](https://david-dm.org/fboes/blogophon/dev-status.svg)](https://david-dm.org/fboes/blogophon?type=dev)\n\nLegal stuff\n-----------\n\nAuthor: [Frank Boës](https://3960.org)\n\nCopyright \u0026 license: See [LICENSE.txt](LICENSE.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffboes%2Fblogophon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffboes%2Fblogophon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffboes%2Fblogophon/lists"}