@clickminded/coauthor-cli 0.0.46 → 0.0.47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -11,7 +11,7 @@ coauthor draft get <id> --format json --json # data.content, the editor do
|
|
|
11
11
|
|
|
12
12
|
The markdown and HTML have no H1: they start with the featured image (once generated) and then the first section. Add the title yourself from `coauthor project show <id> --json` (`data.project.title`) when you hand over a file. Images appear only after they have been generated, and their URLs are public, so the markdown can be pasted anywhere.
|
|
13
13
|
|
|
14
|
-
For a markdown file going into a static-site generator (Astro, Hugo, Next.js, Ghost), add `--frontmatter`: the markdown then starts with a YAML block holding the title, SEO title, meta description, slug, excerpt, and featured image from the post details. Drafts made before post details launched get no frontmatter.
|
|
14
|
+
For a markdown file going into a static-site generator (Astro, Hugo, Next.js, Ghost), add `--frontmatter`: the markdown then starts with a YAML block holding the title, SEO title, meta description, slug, excerpt, and featured image from the post details. Drafts made before post details launched get no frontmatter. SEO posts also get `keyword` and `secondary_keywords`. Every `draft get` response includes `search` in its metadata: `{keyword, secondary_keywords, market}` for SEO posts, `null` otherwise.
|
|
15
15
|
|
|
16
16
|
## Post details (SEO title, meta description, slug, excerpt)
|
|
17
17
|
|
|
@@ -28,6 +28,8 @@ For SEO posts on a profile with a website, `post_details.incoming_link_suggestio
|
|
|
28
28
|
|
|
29
29
|
For SEO posts, `post-details show` also returns `seo`: the target `keyword`, its `market`, `seo_research_credits`, and a `checks` list computed from the current draft and title. Each check has an `id`, a `status` (`pass`, `warn`, `fail`, or `skip` when there is nothing to measure) and a plain `detail`. The ids are `keyword_in_title`, `keyword_in_intro` (first 100 words), `secondary_in_h2`, `table_stakes`, `angle_section`, `questions_answered`, `internal_link`, `outbound_sources` and `length`. A `fail` on the title or intro is worth fixing before publishing: edit the title with `project rename`, or the first paragraph with `draft revise`. `seo` is `null` for other posts.
|
|
30
30
|
|
|
31
|
+
`post_details` also records where the post went: `search_keyword` (the search it was written for), `export_ref` (the last export's destination reference, for example `{destination: "wordpress", wordpress_post_id}`), and `published_url` / `published_at`, which are set only when an export reports the post is live. WordPress exports are always drafts, so they record `export_ref` only.
|
|
32
|
+
|
|
31
33
|
## Share link (public)
|
|
32
34
|
|
|
33
35
|
`coauthor share <id> --json` returns `data.share_url`, a public read-only page anyone with the link can open. Create one only when the user asks for a link. Calling it again returns the same link.
|
|
@@ -391,7 +391,7 @@ coauthor draft get <id> --format json --json # data.content, the editor do
|
|
|
391
391
|
|
|
392
392
|
The markdown and HTML have no H1: they start with the featured image (once generated) and then the first section. Add the title yourself from `coauthor project show <id> --json` (`data.project.title`) when you hand over a file. Images appear only after they have been generated, and their URLs are public, so the markdown can be pasted anywhere.
|
|
393
393
|
|
|
394
|
-
For a markdown file going into a static-site generator (Astro, Hugo, Next.js, Ghost), add `--frontmatter`: the markdown then starts with a YAML block holding the title, SEO title, meta description, slug, excerpt, and featured image from the post details. Drafts made before post details launched get no frontmatter.
|
|
394
|
+
For a markdown file going into a static-site generator (Astro, Hugo, Next.js, Ghost), add `--frontmatter`: the markdown then starts with a YAML block holding the title, SEO title, meta description, slug, excerpt, and featured image from the post details. Drafts made before post details launched get no frontmatter. SEO posts also get `keyword` and `secondary_keywords`. Every `draft get` response includes `search` in its metadata: `{keyword, secondary_keywords, market}` for SEO posts, `null` otherwise.
|
|
395
395
|
|
|
396
396
|
### Post details (SEO title, meta description, slug, excerpt)
|
|
397
397
|
|
|
@@ -408,6 +408,8 @@ For SEO posts on a profile with a website, `post_details.incoming_link_suggestio
|
|
|
408
408
|
|
|
409
409
|
For SEO posts, `post-details show` also returns `seo`: the target `keyword`, its `market`, `seo_research_credits`, and a `checks` list computed from the current draft and title. Each check has an `id`, a `status` (`pass`, `warn`, `fail`, or `skip` when there is nothing to measure) and a plain `detail`. The ids are `keyword_in_title`, `keyword_in_intro` (first 100 words), `secondary_in_h2`, `table_stakes`, `angle_section`, `questions_answered`, `internal_link`, `outbound_sources` and `length`. A `fail` on the title or intro is worth fixing before publishing: edit the title with `project rename`, or the first paragraph with `draft revise`. `seo` is `null` for other posts.
|
|
410
410
|
|
|
411
|
+
`post_details` also records where the post went: `search_keyword` (the search it was written for), `export_ref` (the last export's destination reference, for example `{destination: "wordpress", wordpress_post_id}`), and `published_url` / `published_at`, which are set only when an export reports the post is live. WordPress exports are always drafts, so they record `export_ref` only.
|
|
412
|
+
|
|
411
413
|
### Share link (public)
|
|
412
414
|
|
|
413
415
|
`coauthor share <id> --json` returns `data.share_url`, a public read-only page anyone with the link can open. Create one only when the user asks for a link. Calling it again returns the same link.
|