mirror of
https://github.com/d0zingcat/obsidian-send-to-ghost.git
synced 2026-05-22 23:16:45 +00:00
Update README and manifest
This commit is contained in:
92
README.md
92
README.md
@@ -1,46 +1,46 @@
|
||||
# Obsidian Ghost Publish
|
||||
|
||||
Plugin for publish to [Ghost](https://ghost.org/) site for [Obsidian](https://obsidian.md/) with a single click.
|
||||
|
||||
## How to use
|
||||
|
||||
- Create a custom integration follow this [link](https://ghost.org/integrations/custom-integrations/). You would need an **Admin API Key** and **API URL**.
|
||||
- Once you install the plugin, enable the plugin and add the API KEy and API URL to the setting.
|
||||
- That's it! you now are able to publish the current document by click on the ghost icon on the sidebar or use the command pallete (CMD+P).
|
||||
|
||||
## Frontmatter format
|
||||
|
||||
Obsidian Ghost Publish use frontmatter to specify on how you want to publish your post.
|
||||
|
||||
At the moment, the format is limited to:
|
||||
|
||||
```md
|
||||
title: string (default: file name)
|
||||
tags: (default: [])
|
||||
- tag1
|
||||
- tag2
|
||||
featured: boolean (default: false)
|
||||
published: boolean (default: false)
|
||||
excerpt: string (default: undefined)
|
||||
feature_image: string (default: undefined)
|
||||
```
|
||||
|
||||
Note:
|
||||
|
||||
- `published` will allows you to specify if you want to publish a post now or draft a post.
|
||||
|
||||
### How to run on dev
|
||||
|
||||
- Clone this repo.
|
||||
- `npm i` or `yarn` to install dependencies
|
||||
- `npm run dev` to start compilation in watch mode.
|
||||
|
||||
### Manually installing the plugin
|
||||
|
||||
- Run `npm run build`
|
||||
- Copy over `main.js` and `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
|
||||
|
||||
### Issues & Requests
|
||||
|
||||
- For feature requests, please take use of Discussions.
|
||||
- For any issues with current versions, please use Issues.
|
||||
# Send to Ghost
|
||||
|
||||
A maintained fork of Jay Nguyen's [obsidian-ghost-publish](https://github.com/jaynguyens/obsidian-ghost-publish). It allows you to send Obsidian notes to the [Ghost](https://ghost.org) blogging platform, either as published or draft posts.
|
||||
|
||||
## Usage
|
||||
|
||||
- In Ghost, create a new Custom Integration following [this guide](https://ghost.org/integrations/custom-integrations/). You will need the **Admin API Key** and the **API URL** later.
|
||||
- Install and enable the plugin
|
||||
- In the plugin settings, fill in the API URL and Admin API Key from the Custom Integration you created earlier.
|
||||
- You can now publish documents by clicking the little ghost in the sidebar, or by using the command pallete.
|
||||
|
||||
## Front Matter format
|
||||
|
||||
Send to Ghost uses front matter to set Ghost-specific settings such as the title, tags, and the featured image. You can add front matter by enclosing it in `---` at the beginning of a note.
|
||||
|
||||
The following options are supported:
|
||||
|
||||
```md
|
||||
---
|
||||
title: String (default: filename)
|
||||
tags: (default: none)
|
||||
- tag1
|
||||
- tag2
|
||||
featured: Boolean (default: false)
|
||||
published: Boolean (default: false)
|
||||
excerpt: String (default: blank)
|
||||
feature_image: String (default: blank)
|
||||
---
|
||||
```
|
||||
|
||||
### Development
|
||||
|
||||
This plugin uses PNPM for dependency management.
|
||||
|
||||
- Clone the repository.
|
||||
- Run `pnpm i` to install the necessary dependencies
|
||||
- Run `pnpm dev` to automaticlly recompile as the project files change.
|
||||
|
||||
### Manual installation
|
||||
|
||||
- Run `pnpm build`
|
||||
- Copy `main.js` and `manifest.json` to `VaultFolder/.obsidian/plugins/send-to-ghost/` where `Vaultfolder` is the location of your Obsidian vault.
|
||||
|
||||
### Issues & Support
|
||||
|
||||
If you find a bug in the plugin, please submit an [issue](https://github.com/Southpaw1496/obsidian-send-to-ghost). Otherwise, please contact me via [my website](https://southpaw1496.me).
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
{
|
||||
"id": "ghost-publish",
|
||||
"name": "Ghost Publisher",
|
||||
"id": "send-to-ghost",
|
||||
"name": "Send to Ghost",
|
||||
"version": "1.0",
|
||||
"minAppVersion": "0.12.0",
|
||||
"description": "Single click to publish to Ghost",
|
||||
"description": "Send and publish notes to your Ghost blog with a single click",
|
||||
"author": "Southpaw1496",
|
||||
"authorUrl": "https://southpaw1496.me",
|
||||
"isDesktopOnly": false
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user