Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phildl/ts-ghost
A collection of TypeScript packages and tools to interact with a ghost blog. Type-safe 🦾 Ghost Content API client and CLI 🤖 tool to export posts in Markdown.
https://github.com/phildl/ts-ghost
ghost ghost-blog ghost-content-api hacktoberfest markdown typescript zod
Last synced: about 1 month ago
JSON representation
A collection of TypeScript packages and tools to interact with a ghost blog. Type-safe 🦾 Ghost Content API client and CLI 🤖 tool to export posts in Markdown.
- Host: GitHub
- URL: https://github.com/phildl/ts-ghost
- Owner: PhilDL
- License: mit
- Created: 2023-02-21T18:30:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-08T19:03:53.000Z (7 months ago)
- Last Synced: 2024-04-08T21:36:41.009Z (7 months ago)
- Topics: ghost, ghost-blog, ghost-content-api, hacktoberfest, markdown, typescript, zod
- Language: TypeScript
- Homepage: https://ts-ghost.dev
- Size: 2.14 MB
- Stars: 33
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
ts-ghost
@ts-ghost is a collection of tools written in TypeScript to interract with a Ghost Blog. Strongly 🦾 typed Content-Api, Cli tools, and more coming!
 
## About The Project
[Ghost](https://ghost.org/) is an amazing open source blogging platform. Beautiful CMS and good API but there is lack of strongly types TypeScript libraries to interact with its API. This is where the `ts-ghost` suite comes in.
Here you will find links to the different packages of the `ts-ghost` suite.
## [💻 Ghost blog Buster](https://github.com/PhilDL/ts-ghost/tree/main/apps/ghost-blog-buster)
An elegant cli 🤖 to interact with your Ghost Blog directly via the Ghost Content API or Admin API and export posts in Markdown format. From the cli you will be able to:
```shell
npx @ts-ghost/ghost-blog-buster
```
or
```shell
npm install -g @ts-ghost/ghost-blog-buster
```
- 🌪️ Choose between **Content API** or **Admin API** (for members or blog post content behind subscribption)
- 📚 Export specific or all blog **Posts** in **Markdown** format to the folder of your choice.
- ⚙️ Display or export to JSON your **Tags**, **Tiers**, **Authors**, **Members** (Admin API only)
- 📶 Connect / Disconnect from the Blog
- [Documentation](https://ts-ghost.dev/docs/ghost-blog-buster) — [GitHub](https://github.com/PhilDL/ts-ghost/tree/main/apps/ghost-blog-buster) — [npm](https://www.npmjs.com/package/@ts-ghost/ghost-blog-buster)
## [📦 TS Ghost Content API](https://github.com/PhilDL/ts-ghost/tree/main/packages/ts-ghost-content-api)
A strongly 🦾 typed TypeScript library to interact with the Ghost Content API:
```shell
npm install @ts-ghost/content-api
```
- Browse and Read your blog **Posts**, **Pages**, **Tags**, **Tiers**, **Authors** and **Settings**
- Type-safe Inputs/Outputs.
- Models schema and run-type safety with [Zod](https://github.com/colinhacks/zod).
- [Documentation](https://ts-ghost.dev/docs/content-api) — [GitHub](https://github.com/PhilDL/ts-ghost/tree/main/packages/ts-ghost-content-api) — [npm](https://www.npmjs.com/package/@ts-ghost/content-api)
## [📦 TS Ghost Admin API](https://github.com/PhilDL/ts-ghost/tree/main/packages/ts-ghost-admin-api)
A strongly 🦾 typed TypeScript library to interact with the Ghost Admin API:
```shell
npm install @ts-ghost/admin-api
```
- Browse/Read/Add/Edit/Delete your blog **Posts**, **Pages**, **Members**, **Tags**, **Tiers**, **Offers**, **Newsletters**, **Users**, **webhooks**, **Site**, ...
- Type-safe Inputs/Outputs for all CRUD methods.
- Models schema and run-type safety with [Zod](https://github.com/colinhacks/zod).
- [Documentation](https://ts-ghost.dev/docs/admin-api) — [GitHub](https://github.com/PhilDL/ts-ghost/tree/main/packages/ts-ghost-admin-api) — [npm](https://www.npmjs.com/package/@ts-ghost/admin-api)
## [📦 TS Ghost Core API](https://github.com/PhilDL/ts-ghost/tree/main/packages/ts-ghost-core-api)
The base building block containing the APIComposer and Fetchers (Browse / Read / Mutations) accepting Zod Schemas.
```shell
npm install @ts-ghost/core-api
```
- Input type-safety of the Ghost API params
- Modify Type Output based on Input params
- [Documentation](https://ts-ghost.dev/docs/core-api) — [GitHub](https://github.com/PhilDL/ts-ghost/tree/main/packages/ts-ghost-core-api) — [npm](https://www.npmjs.com/package/@ts-ghost/core-api)
## Roadmap
- Ghost Admin API integration
- Better handling of weird Ghost "include" params in API call
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
- If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/PhilDL/ts-ghost/issues/new) to discuss it, or directly create a pull request after you edit the _README.md_ file with necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.
- Please also read through the [Code Of Conduct](https://github.com/PhilDL/ts-ghost/blob/main/CODE_OF_CONDUCT.md) before posting your first idea as well.
## License
Distributed under the MIT License. See [LICENSE](https://github.com/PhilDL/ts-ghost/blob/main/LICENSE.md) for more information.
## Authors
- **[PhilDL](https://github.com/PhilDL)** - _Creator_
## Acknowledgements
- [Ghost](https://ghost.org/) is the best platform for blogging 💖 and have a good JS Client library that was a real inspiration.
- [Zod](https://github.com/colinhacks/zod) is a TypeScript-first library for data validation and schema building.
- [Clack](https://github.com/natemoo-re/clack) to build beautiful prompts.