Skip to content

Commit f2a1c23

Browse files
committed
Chore: Improve README.md
1 parent d2f9660 commit f2a1c23

1 file changed

Lines changed: 19 additions & 15 deletions

File tree

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,34 @@ If you don't find a log in your publication dashboard on Hashnode, but have made
88
* the file ends with .md extension, we support markdown files only.
99
* you have connected the same repo as you made a commit to.
1010
* you added the correct blog domain in your markdown file.
11-
* Frontmatter: Make sure each post has these details at the top of the file.
11+
* Frontmatter: Make sure each article has these details at the top of the file.
1212

1313
```
14-
title: YOUR_TITLE_HERE
15-
subtitle: YOUR_SUBTITLE_HERE
16-
slug: CUSTOM_SLUG_HERE
17-
tags: TAG_SLUG_1, TAG_SLUG_2
18-
cover: COVER_IMAGE_URL
19-
domain: YOUR_DOMAIN_NAME_HERE (e.g. sandeep.dev or sandeep.hashnode.dev)
20-
/* When you have a team publication and a publication member has created a post */
21-
publishAs: USERNAME_OF_AUTHOR_OF_POST
22-
/* When your post is republished and you want to use
23-
the origin url as canonical url for this post */
24-
canonical: CANONICAL_URL_OF_POST
25-
/* Only if you don't want this post to be published yet */
14+
title: YOUR_TITLE_HERE **(Required)**
15+
subtitle: YOUR_SUBTITLE_HERE
16+
/* The pathname of your article url
17+
* Ex. In https://engineering.hashnode.com/how-we-autodetect-spam-using-googles-vertex-ai
18+
"how-we-autodetect-spam-using-googles-vertex-ai" is the slug */
19+
slug: CUSTOM_ARTICLE_SLUG_HERE (Will be created automatically if not provided)
20+
tags: TAG_SLUG_1, TAG_SLUG_2 **(Required)** - You can find the list of tags <a href="https://github.com/Hashnode/support/blob/main/misc/tags.json" className="font-bold text-brand-blue" target="_blank">here</a>
21+
/* You need to upload your image to https://hashnode.com/uploader
22+
and use the uploaded image URL as COVER_IMAGE_URL */
23+
cover: COVER_IMAGE_URL
24+
domain: YOUR_HASHNODE_BLOG_DOMAIN_NAME_HERE (e.g. sandeep.dev or sandeep.hashnode.dev) **(Required)**
25+
/* When you have a team publication and a publication member has created an article */
26+
/* Please note that this param is only supported while creating an article and not updating */
27+
publishAs: USERNAME_OF_AUTHOR_OF_ARTICLE
28+
/* When your article is republished and you want to use the origin url as canonical url */ <br/>
29+
canonical: CANONICAL_URL_OF_ARTICLE
30+
/* Only if you don't want this article to be published yet */
2631
ignorePost: true
2732
28-
2933
Enter article body here
3034
```
3135

3236
* Make sure you haven't included **ignorePost** in the frontmatter by mistake.
3337
* Uninstalling app via Github will remove it from all the publications that the repo was connected to. If you want to specifically remove the installation from a particular publication, do it from it's Dashboard (Integrations section).
34-
* Creating a post with same slug as another post in the publication will overwrite the old post.
38+
* Creating an article with same slug as another article in the publication will overwrite the old article.
3539
* Do note that maximum of 10 file changes are respected in one particular commit.
3640

3741

0 commit comments

Comments
 (0)