https://github.com/dmyates/ghostly_kerning

Typeset.js integration for Ghost (plus excerpt enhancements).
https://github.com/dmyates/ghostly_kerning

ghost typeset

Last synced: 2 months ago
JSON representation

Typeset.js integration for Ghost (plus excerpt enhancements).

• Host: GitHub
• URL: https://github.com/dmyates/ghostly_kerning
• Owner: dmyates
• License: mit
• Created: 2015-08-29T20:07:38.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-07-15T20:28:11.000Z (almost 6 years ago)
• Last Synced: 2025-06-25T23:06:04.306Z (about 1 year ago)
• Topics: ghost, typeset
• Language: JavaScript
• Size: 4.88 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Ghostly Kerning

===============

A simple app (plugin) for the Ghost blogging platform which formats post excerpts and contents using David Merfield's [Typeset](https://github.com/davidmerfield/typeset) HTML pre-processor.

The new `excerpt-typeset` Handlebars helper also contains the following enhancements:

* Removes the text of headings, blockquotes and `` tags.

* Provides truncation according to sentences, in addition to words or characters.

This was made mostly for my personal use, so it's a bit schizo. As I don't use Ghost for my personal website anymore, I'm not going to be updating it. Please hack it up to be more to your liking.

Installation

------------

1. Place the app directory in `content/apps/`.

2. Run `npm install` in the `content/apps/ghostly_kerning` directory.

3. Add it to your active apps by appending it to the array in the `value` field of the `activeApps` record in the `settings`. You can do this by access your blog database directly through a SQLite/Postgres client, or by [exporting a backup of your blog and editing the JSON](https://github.com/TryGhost/Ghost/wiki/Apps-Getting-Started-for-Ghost-Devs).

Usage

-----

Replace `{{content}}` and `{{excerpt}}` helpers in your theme with `{{content_typeset}}` and `{{excerpt_typeset}}`. Optionally, use the sentence truncation feature like so `{{excerpt_typeset sentences="4"}}` to make your excerpt the first four sentences.

Include [typeset.css](https://blot.im/typeset/demo/typeset.css) in your theme and tweak it for your chosen font for full advantage.

Todo

----

* Find an elegant way of spinning the excerpt features off into their own app that is compatible and not redundant with this one.

* Split into more files once [this issue gets fixed](https://github.com/TryGhost/Ghost/issues/5356).