@clickminded/coauthor-cli 0.0.46 → 0.0.48
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
|
|
|
@@ -26,7 +26,9 @@ coauthor post-details set <id> --seo-title "..." --description "..." --slug "...
|
|
|
26
26
|
|
|
27
27
|
For SEO posts on a profile with a website, `post_details.incoming_link_suggestions` lists existing pages on the user's site that could link to the new post: `{status, suggestions: [{url, title, anchor, sentence}]}`. `status` is `ready`, `none`, or `index_not_ready` (the site was still being indexed when the draft was written; links appear on the next post). It is read-only. After the post is published, offer the user the sentences to add on those pages, linking the anchor text to the new post's URL. It is `null` for other posts.
|
|
28
28
|
|
|
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
|
|
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 is worth fixing before publishing: edit it with `project rename`. A `warn` on `keyword_in_intro` is fine when the keyword wouldn't read naturally in the opening, so don't force it in. `questions_answered` is optional: it reports `pass` or `skip`, never `warn`. `seo` is `null` for other posts.
|
|
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.
|
|
30
32
|
|
|
31
33
|
## Share link (public)
|
|
32
34
|
|
|
@@ -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
|
|
|
@@ -406,7 +406,9 @@ coauthor post-details set <id> --seo-title "..." --description "..." --slug "...
|
|
|
406
406
|
|
|
407
407
|
For SEO posts on a profile with a website, `post_details.incoming_link_suggestions` lists existing pages on the user's site that could link to the new post: `{status, suggestions: [{url, title, anchor, sentence}]}`. `status` is `ready`, `none`, or `index_not_ready` (the site was still being indexed when the draft was written; links appear on the next post). It is read-only. After the post is published, offer the user the sentences to add on those pages, linking the anchor text to the new post's URL. It is `null` for other posts.
|
|
408
408
|
|
|
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
|
|
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 is worth fixing before publishing: edit it with `project rename`. A `warn` on `keyword_in_intro` is fine when the keyword wouldn't read naturally in the opening, so don't force it in. `questions_answered` is optional: it reports `pass` or `skip`, never `warn`. `seo` is `null` for other posts.
|
|
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.
|
|
410
412
|
|
|
411
413
|
### Share link (public)
|
|
412
414
|
|