Description

Title

Ghost Developer Docs

Ghost is an open source, professional publishing platform built on a modern Node.js technology stack — designed for teams who need power, flexibility and performance.

Introduction

The fastest way to get started is to set up a site on **Ghost(Pro)**. If you're running a self-hosted instance, we strongly recommend an Ubuntu server with at least 1GB of memory to run Ghost.

Installation

How To Install Ghost

A short guide to running Ghost in a production environment and setting up an independent publication to serve traffic at scale.

Hosting Guide

Hosting Ghost

Learn how to update your self-hosted Ghost install to the latest version

Updates & Versions

How To Update Ghost

Developing Ghost as a product is a complex process undertaken by a small number of people with a great deal of care.

Overview

Product Principles & Roadmap

Ghost is structured as a modern, decoupled web application with a sensible service-based architecture.

Architecture

For self-hosted Ghost users, a custom configuration file can be used to override Ghost’s default behaviour. This provides you with a range of options to configure your publication to suit your needs.

Configuration

Staff users within Ghost have access to the admin area with varying levels of permissions for what they can do.

Staff Users

Posts are the primary entry-type within Ghost, and generally represent the majority of stored data.

Publishing

The native Members feature in Ghost makes it possible to launch a membership business from any Ghost publication, with member signup, paid subscriptions and email newsletters built-in.

Memberships

Recommendations

Sites using the Members feature benefit from built-in email newsletters, where all posts can be delivered directly to segments of your audience in just a few clicks.

Newsletters

Email Newsletters

Ghost is committed to developing secure, reliable products utilising all modern security best practices and processes.

Security

Ghost Security

The Ghost theme layer has been engineered to give developers and designers the flexibility to build custom publications that are powered by the Ghost platform.

Ghost Handlebars Themes

A Ghost theme contains static HTML templates that make use of helpers to output data from your site, and custom CSS for styling.

Structure

Each page in a Ghost theme belongs to a context, which determines which template is used, what data will be available and what content is output by the `{{body_class}}` helper.

Contexts

Ghost themes support automatic image resizing, allowing you to use a minimal handlebars helper to output different image sizes.

Assets

The open-source Ghost editor is robust and extensible.

Content

Ghost has a native search feature that can be accessed via URL or implemented directly into themes using a single data attribute.

Search

The Members feature allows you to turn any site into a membership business with member signup, paid subscriptions and email newsletters.

Members

Routing is the system that maps URL patterns to data and templates within Ghost. It comes pre-configured by default, but it can also be customized extensively to build powerful custom site structures.

Routing

URLs & Dynamic Routing

Custom theme settings are a powerful tool that allows theme developers to configure custom settings that appear in Ghost Admin — making it easy for site owners to make stylistic choices without needing to edit theme files.

Custom Settings

Validating your Ghost theme is handled efficiently with the GScan tool. GScan will check your theme for errors, deprecations and compatibility issues. GScan is used in several ways:

GScan

A fully loaded tool to help you get Ghost installed and configured and to make it super easy to keep your Ghost install up to date.

Ghost CLI

How to use Ghost as a headless CMS with popular static site generators

JAMstack

Ghost On The JAMstack

Webhooks are specific events triggered when something happens in Ghost, like publishing a new post or receiving a new member

Webhooks

Frequently asked questions and answers about running Ghost

Ghost Developer FAQs

A catalog of critical changes between major Ghost versions

Breaking Changes

Ghost is completely open source software built almost entirely by volunteer contributors who use it every day.

Contributing

Contributing To Ghost

Ghost is free software released under the [MIT License](http://en.wikipedia.org/wiki/MIT_License), which pretty much means you can do anything you want with it. The MIT License is one of the most free and open licenses in the world, and does not restrict how you use the software which it’s applied to. We believe open source software should be free. As in free.

License

The Ghost brand is our pride and joy. We’ve gone to great lengths to make it as beautiful as possible, so we care a great deal about keeping it that way! These guidelines provide all of our official assets and styles, along with details of how to correctly use them.

Logos

Trademark

Migrating To Ghost

Migrate from Substack and import your content to Ghost with this guide

Migrating from Substack

Migrate from BeeHiiv and import your content to Ghost with this guide

Migrating from BeeHiiv

Migrate from WordPress and import your content to Ghost with this guide

Migrating from WordPress

Migrate from Newspack and import your content to Ghost with this guide. You can manage a migration from Newspack yourself or, if you prefer, our team can take care of the migration for you.

Migrating from Newspack

Migrate from Medium and import your content to Ghost with this guide

Migrating from Medium

Official guide: How to migrate from Squarespace to Ghost

Migrating from Squarespace

Migrate from Kit and import your subscribers to Ghost with this guide

Migrating from Kit

Migrate from Mailchimp and import your content to Ghost with this guide

Migrating from Mailchimp

Migrate from Patreon and import your Patrons to Ghost with this guide

Migrating from Patreon

Migrate from Buttondown and import your content to Ghost with this guide

Migrating from Buttondown

Migrate from Memberful and import your members to Ghost with this guide

Migrating from Memberful

Migrate from Gumroad and import your customers to Ghost with this guide

Migrating from Gumroad

Migrate from Jekyll and import your content to Ghost with this guide

Migrating from Jekyll

Migrate from a self-hosted instance to Ghost(Pro) with this guide

Migrating from Ghost To Ghost

If no export tools exist for your current blogging system you’ll need to create one that generates a JSON file as described here. There is a full example at the end of this file. Please note that your final JSON file should have no comments in the final format. Those are only included here for readability and explanatory purposes.

Developer Migration Docs

Welcome to the home of your new documentation

Start building awesome documentation in under 5 minutes

Quickstart

Development

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Example section for showcasing API endpoints

Returns all plants from the system that the user has access to

Get Plants

Create Plant

Deletes a single plant based on the ID supplied

Getting Started

Core Concepts

Themes

Advanced Tools

Resources

Title

Description

Getting Started

Core Concepts

Themes

Advanced Tools

Resources

​Description

Description