Skip to content

Commit d2f9660

Browse files
authored
Update README.md
1 parent 701ecc7 commit d2f9660

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
11
# Hashnode-source-from-github-template
22
A template with boilerplate structure for Hashnode's Github as source feature
3+
4+
Please note: A **README.md** at the root is always ignored.
5+
6+
If you don't find a log in your publication dashboard on Hashnode, but have made a commit to your connected repo, then make sure
7+
8+
* the file ends with .md extension, we support markdown files only.
9+
* you have connected the same repo as you made a commit to.
10+
* 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.
12+
13+
```
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 */
26+
ignorePost: true
27+
28+
29+
Enter article body here
30+
```
31+
32+
* Make sure you haven't included **ignorePost** in the frontmatter by mistake.
33+
* 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.
35+
* Do note that maximum of 10 file changes are respected in one particular commit.
36+
37+
38+

0 commit comments

Comments
 (0)