Skip to content

Commit bad05fd

Browse files
theevilheadtheevilhead
committed
feat: Update README.md
1 parent d7251b2 commit bad05fd

1 file changed

Lines changed: 162 additions & 25 deletions

File tree

‎README.md‎

Lines changed: 162 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,174 @@ If you don't find a log in your publication dashboard on Hashnode, but have made
99
* you have connected the same repo as you made a commit to.
1010
* you added the correct blog domain in your markdown file.
1111
* Frontmatter: Make sure each article has these details at the top of the file.
12-
12+
* A **README.md** at the root is always ignored.
13+
14+
## Supported front matter fields and their description
15+
1316
```
1417
---
15-
title: YOUR_TITLE_HERE **(Required)**
16-
subtitle: YOUR_SUBTITLE_HERE
17-
/* The pathname of your article url
18-
* Ex. In https://engineering.hashnode.com/how-we-autodetect-spam-using-googles-vertex-ai
19-
"how-we-autodetect-spam-using-googles-vertex-ai" is the slug */
20-
slug: CUSTOM_ARTICLE_SLUG_HERE (Will be created automatically if not provided)
21-
tags: TAG_SLUG_1, TAG_SLUG_2 **(Required)** - You can find the list of tags here https://github.com/Hashnode/support/blob/main/misc/tags.json
22-
/* You need to upload your image to https://hashnode.com/uploader
23-
and use the uploaded image URL as COVER_IMAGE_URL */
24-
cover: COVER_IMAGE_URL
25-
domain: YOUR_HASHNODE_BLOG_DOMAIN_NAME_HERE (e.g. sandeep.dev or sandeep.hashnode.dev) **(Required)**
26-
/* When you have a team publication and a publication member has created an article */
27-
/* Please note that this param is only supported while creating an article and not updating */
28-
publishAs: USERNAME_OF_AUTHOR_OF_ARTICLE
29-
/* When your article is republished and you want to use the origin url as canonical url */
30-
canonical: CANONICAL_URL_OF_ARTICLE
31-
/* Only if you don't want this article to be published yet */
32-
ignorePost: Boolean (default: false)
33-
/* If you want to post it only on your blog and hide it from Hashnode community feed */
34-
hideFromHashnodeCommunity: Boolean (default: false)
18+
# Post Title
19+
# String | *REQUIRED*
20+
# Ex: Top 4 React UI Libraries for 2023
21+
title: Example title here
22+
23+
# Post Slug
24+
# What is slug? https://www.semrush.com/blog/what-is-a-url-slug
25+
# String | *REQUIRED*
26+
# Ex: top-4-react-ui-libraries-for-2023
27+
# - This is the URL of the post. It should be unique and should not be used by any other post.
28+
# - If you use the same slug of an existing post, the existing post will be updated.
29+
# - In order to let users update the post SLUG, we depend on the post slug as well
30+
# as it's path in the repo.
31+
# - If you change both path and slug of the post, the post will be treated as a new post and
32+
# will be published with a new slug.
33+
# - If you change only the slug of the post, the post will be updated with the new slug.
34+
# - If you change only the path of the post, the post will be will be updated with new path
35+
# and any other changes along with it if any.
36+
slug: example-slug
37+
38+
# Tags
39+
# String (comma-separated tag slugs) | *REQUIRED*
40+
# Ex: reactjs, css, python, nodejs
41+
# Upto 5 tag slugs
42+
# - You can find tags information from here https://github.com/Hashnode/support/blob/main/misc/tags.json
43+
# You can also update a post to edit this later.
44+
tags: reactjs, css, python, nodejs
45+
46+
# Publication Domain (hashnode.dev subdomain or your custom domain)
47+
# String | *REQUIRED*
48+
# Ex: townhall.hashnode.com
49+
# - This can also be a hashnode.dev subdomain as well.
50+
# - The publication domain name that you want to publish the post to.
51+
# This should be a valid domain name only.
52+
# - You should be an ADMIN of the publication to publish.
53+
domain: example.hashnode.dev
54+
55+
# Subtitle of the post
56+
# String | Optional
57+
# Ex: A curated list of the best React UI libraries for 2023
58+
subtitle:
59+
60+
# Cover Image URL of the post
61+
# String | Optional
62+
# Note: You must upload the image to Hashnode's CDN, before you can use it here.
63+
# Ex: https://cdn.hashnode.com/res/hashnode/image/upload/v1681132538878/itnaYF1h-.png
64+
# - To upload, Login to Hashnode and go to https://hashnode.com/uploader
65+
# Use the URL that is generated after the upload.
66+
cover:
67+
68+
# Should the post be ignored? When true it will not be picked up by Hashnode.
69+
# Boolean | Optional
70+
# Default value: false
71+
# Ex: true
72+
# - It's useful when you want to keep the post in your repo but don't
73+
# want it to be picked up by Hashnode.
74+
ignorePost:
75+
76+
# Publish on behalf of a team publication member
77+
# Username of the publication member
78+
# String | Optional | *WORKS WITH TEAM PUBLICATION ONLY*
79+
# Ex: sandeep
80+
# - This resembles the Change of author from draft settings of a
81+
# team publication in Hashnode editor.
82+
# - Fails if the user is not a member of the team publication or
83+
# if the publication is not a team publication
84+
publishAs:
85+
86+
# Canonical URL of the post
87+
# String | Optional
88+
# What is a canonical URL? https://moz.com/learn/seo/canonicalization
89+
# Ex: https://www.hashnode.com/post/top-4-react-ui-libraries-for-2023
90+
# - This is equivalent to original URL option present in draft settings
91+
# of a post in Hashnode editor.
92+
# - This is useful when you want to publish a post that is already
93+
# published on another platform.
94+
canonical:
95+
96+
97+
# Hide from Hashnode Community
98+
# Boolean | Optional
99+
# Default value: false // by default the post will be visible in the Hashnode's public feed.
100+
# Ex: true
101+
# - This is equivalent to "HIDE ARTICLE FROM HASHNODE FEED" option
102+
# present in draft settings of a post in Hashnode editor.
103+
# - This is useful when you want to publish a post to your publication
104+
# only but hide it from the Hashnode's public feed.
105+
# - You can also update a post to enable/disable this later.
106+
hideFromHashnodeCommunity:
107+
108+
# SEO Title
109+
# String | Optional
110+
# Ex: Top 4 React UI Libraries for 2023
111+
# - This is equivalent to SEO TITLE option present in draft settings
112+
# of a post in Hashnode editor.
113+
# - You can also update a post to update this later.
114+
seoTitle:
115+
116+
# SEO Description
117+
# String | Optional
118+
# Ex: A curated list of the best React UI libraries for 2023
119+
# - This is equivalent to SEO DESCRIPTION option present in
120+
# draft settings of a post in Hashnode editor.
121+
# - You can also update a post to update this later.
122+
seoDescription:
123+
124+
# Disable comments for a post
125+
# Boolean | Optional
126+
# Default value: false // by default the comments will be enabled for the post.
127+
# Ex: true
128+
# - This is equivalent to "DISABLE COMMENTS" option present in
129+
# draft settings of a post in Hashnode editor.
130+
# - You can also update a post to enable/disable this later.
131+
disableComments:
132+
133+
# Slug of the series that you want your post to be a part of
134+
# String | Optional
135+
# Ex: react-series
136+
# - This is equivalent to "ADD TO A SERIES" option present in
137+
# draft settings of a post in Hashnode editor.
138+
# - If invalid series is given, the post will not be added to any series.
139+
# - You can update the post again to correct it later.
140+
# - You can find series information from the series section in your publication dashboard.
141+
# You can also edit the series information from there.
142+
seriesSlug: // slug of the series
143+
144+
# Table of contents
145+
# Boolean | Optional
146+
# Default value: false // by default the table of contents will not be added to the post.
147+
# Ex: true
148+
# - This is equivalent to "GENERATE TABLE OF CONTENTS" option
149+
# present in draft settings of a post in Hashnode editor.
150+
# - If true, the table of contents will be added to the post.
151+
# - You can also update a post to enable/disable this later.
152+
enableToc:
153+
154+
# Save post as draft
155+
# Boolean | Optional
156+
# Default value: false // by default the post will be published.
157+
# Ex: true
158+
# - If true, the post will be saved as a draft.
159+
# - You can also update a draft with all the above attributes.
160+
# - This draft will be available under Drafts section of the
161+
# left sidebar in your publication dashboard.
162+
# - Note: Once you remove this attribute, the post will be
163+
# published and removed from drafts automatically.
164+
# - This follows the same rules as a post create and update
165+
# flow as well as the slug rules mentioned since
166+
# beginning of this manual.
167+
saveAsDraft:
168+
169+
170+
# Note:
171+
# This is in beta currently
172+
# Newsletter and Post scheduling is NOT supported as of now.
173+
35174
---
36-
37-
Enter article body here
38175
```
39176
* List of tags can be found here https://github.com/Hashnode/support/blob/main/misc/tags.json
40177
* Make sure you haven't included **ignorePost** in the frontmatter by mistake.
41-
* 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).
42-
* Creating an article with same slug as another article in the publication will overwrite the old article.
178+
* 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 (GitHub section).
179+
* You cannot create a new draft or a post with already published slugs
43180
* Do note that maximum of 10 file changes are respected in one particular commit.
44181

45182

0 commit comments

Comments
 (0)