Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steven-mercatante/gatsby-post-manager
Gatsby Post Manager helps you quickly see which of your posts are published, pending, and unpublished.
https://github.com/steven-mercatante/gatsby-post-manager
command-line command-line-tool gatsby gatsbyjs
Last synced: 21 days ago
JSON representation
Gatsby Post Manager helps you quickly see which of your posts are published, pending, and unpublished.
- Host: GitHub
- URL: https://github.com/steven-mercatante/gatsby-post-manager
- Owner: steven-mercatante
- License: mit
- Created: 2019-09-13T22:52:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T10:23:33.000Z (about 2 years ago)
- Last Synced: 2024-10-28T17:20:10.464Z (2 months ago)
- Topics: command-line, command-line-tool, gatsby, gatsbyjs
- Language: JavaScript
- Homepage:
- Size: 544 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gatsby Post Manager
[](https://www.npmjs.com/package/gatsby-post-manager)
[](https://travis-ci.org/steven-mercatante/gatsby-post-manager)
Gatsby Post Manager (`gpm`) is a command line tool that:
- helps keep track of Gatsby posts, and easily see which ones are published, pending, or unpublished
- create new posts from a template
## Installation
```bash
$ npm install -g gatsby-post-manager
```
## Usage
`gpm` is opinionated - it assumes your posts:
- use the `.md` or `.mdx` file extensions
- have a required `published` boolean flag in their frontmatter
- have an optional `date` attribute (format: `YYYY-MM-DD`) in their frontmatter
`gpm` will recursively search the provided content path (the `--dir` option) for posts.
Below is my example directory structure. All `gpm` commands are invoked from the `site` root.
```
site/
├── content/
│ ├── posts/
│ | ├── my-first-post/
│ | | └── index.md
│ | ├── my-second-post/
│ | | └── index.mdx
│ | └── my-third-post.md
```
### List all posts, including their status:
```bash
$ gpm -d content posts
# or
$ gpm -d content p
```
### List posts whose `status` is one of: `published`, `pending`, or `unpublished`
```bash
# status flags: --published, --pending, --unpublished
$ gpm -d content posts --pending
# or
$ gpm -d content p --pending
```
### How does gpm determine post status?
- A post's status is `published` if its `published` attribute is `true`, and its `date` attribute occurs before or is equal to today's date (if the post has a `date` attribute)
- A post's status is `pending` if its `published` attribute is `true`, and its `date` attribute occurs after today's date (if the post has a `date` attribute)
- A post's status is `published` if its `published` attribute is `true`, and it does not have a `date` attribute
- A post's status is `unpublished` if its `published` attribute is not `true`, or doesn't have a `published` attribute at all
### Display post stats:
```bash
$ gpm -d content post-stats
# or
$ gpm -d content ps
```
### Create a post:
```
$ gpm posts new path/to/posts "hello world"
```
will create a new `path/to/posts/hello-world.md` file whose frontmatter looks like:
```yaml
---
title: Hello World
slug: "hello-world"
tags: []
published: false
date: "2019-09-23"
---
Add your content here
```