Home

Welcome to the Ghost Github wiki!

The wiki contains all kinds of documentation about the development of Ghost, and is also the place where you'll find early documentation for working with the various APIs. These documents are usually aimed at the people developing features, so they're rough around the edges, but they're here nonetheless.

Here's a quick list of the most useful pages:

General:

• Roadmap (mostly a link to the Public Roadmap)
• Planned Features
• Core Team

For contributors:

• Contributing Guide
• Code standards
• Git workflow
• Grunt Toolkit

Codebase docs:

• Codebase Overview
• Tech architecture vision
• How does OAuth work with Ghost
• HTML email template generation
• Reserved slugs

API docs:

• JSON format (for imports/exports)
• Using Ghost as an npm module
• Using a custom storage module

Product vision:

• Post Scheduling 101
• Channels 101
• Tags 101
• Imagining the Ghost Developer Kit
• Accounts API

Where else do I find documentation?

If you're a developer looking for the official developer documentation for things like themes, apps and the data API, you'll find that at docs.ghost.org.

If you're a user looking for information on installing, configuring and using Ghost, you'll find all those details in our user documentation at support.ghost.org.

If you're looking for a helping hand the best place is the Ghost slack team, where the Ghost staff & community are all on hand to answer your queries.