Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Hashnode/Hashnode-source-from-github-template

A template with boilerplate structure for Hashnode's Github as source feature
https://github.com/Hashnode/Hashnode-source-from-github-template

Last synced: 5 months ago
JSON representation

A template with boilerplate structure for Hashnode's Github as source feature

Awesome Lists containing this project

README 

        
# Hashnode-source-from-github-template

A template with boilerplate structure for Hashnode's Github as source feature



Please note: A **README.md** at the root is always ignored.



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



*   the file ends with .md extension, we support markdown files only.

*   you have connected the same repo as you made a commit to.

*   you added the correct blog domain in your markdown file.

*   Frontmatter: Make sure each article has these details at the top of the file.

*   A **README.md** at the root is always ignored.



## Supported front matter fields and their description



```

---

# Post Title

# String | *REQUIRED*

# Ex: Top 4 React UI Libraries for 2023

title: Example title here

 

# Post Slug

# What is slug? https://www.semrush.com/blog/what-is-a-url-slug

# String | *REQUIRED*

# Ex: top-4-react-ui-libraries-for-2023

# - This is the URL of the post. It should be unique and should not be used by any other post.

# - If you use the same slug of an existing post, the existing post will be updated.

# - In order to let users update the post SLUG, we depend on the post slug as well 

#   as it's path in the repo.

# - If you change both path and slug of the post, the post will be treated as a new post and

#   will be published with a new slug.

# - If you change only the slug of the post, the post will be updated with the new slug.

# - If you change only the path of the post, the post will be will be updated with new path 

#   and any other changes along with it if any.

slug: example-slug

 

# Tags

# String (comma-separated tag slugs) | *REQUIRED*

# Ex: reactjs, css, python, nodejs

# Upto 5 tag slugs

# - You can find tags information from here https://github.com/Hashnode/support/blob/main/misc/tags.json

# You can also update a post to edit this later.

tags: reactjs, css, python, nodejs

 

# Publication Domain (hashnode.dev subdomain or your custom domain)

# String | *REQUIRED*

# Ex: townhall.hashnode.com

# - This can also be a hashnode.dev subdomain as well.

# - The publication domain name that you want to publish the post to. 

#   This should be a valid domain name only.

# - You should be an ADMIN of the publication to publish.

domain: example.hashnode.dev

 

# Subtitle of the post

# String | Optional

# Ex: A curated list of the best React UI libraries for 2023

subtitle: 

 

# Cover Image URL of the post

# String | Optional

# Note: You must upload the image to Hashnode's CDN, before you can use it here.

# Ex: https://cdn.hashnode.com/res/hashnode/image/upload/v1681132538878/itnaYF1h-.png

# - To upload, Login to Hashnode and go to https://hashnode.com/uploader

#   Use the URL that is generated after the upload.

cover: 

 

# Should the post be ignored? When true it will not be picked up by Hashnode.

# Boolean | Optional

# Default value: false

# Ex: true

# - It's useful when you want to keep the post in your repo but don't

#   want it to be picked up by Hashnode.

ignorePost: 

 

# Publish on behalf of a team publication member

# Username of the publication member

# String | Optional | *WORKS WITH TEAM PUBLICATION ONLY*

# Ex: sandeep

# - This resembles the Change of author from draft settings of a 

#   team publication in Hashnode editor.

# - Fails if the user is not a member of the team publication or 

#   if the publication is not a team publication

publishAs: 

 

# Canonical URL of the post

# String | Optional

# What is a canonical URL? https://moz.com/learn/seo/canonicalization

# Ex: https://www.hashnode.com/post/top-4-react-ui-libraries-for-2023

# - This is equivalent to original URL option present in draft settings

#   of a post in Hashnode editor.

# - This is useful when you want to publish a post that is already

#   published on another platform.

canonical:

 

 

# Hide from Hashnode Community

# Boolean | Optional

# Default value: false // by default the post will be visible in the Hashnode's public feed.

# Ex: true

# - This is equivalent to "HIDE ARTICLE FROM HASHNODE FEED" option

#   present in draft settings of a post in Hashnode editor.

# - This is useful when you want to publish a post to your publication 

#   only but hide it from the Hashnode's public feed.

# - You can also update a post to enable/disable this later.

hideFromHashnodeCommunity: 

 

# SEO Title

# String | Optional

# Ex: Top 4 React UI Libraries for 2023

# - This is equivalent to SEO TITLE option present in draft settings

#   of a post in Hashnode editor.

# - You can also update a post to update this later.

seoTitle: 

 

# SEO Description

# String | Optional

# Ex: A curated list of the best React UI libraries for 2023

# - This is equivalent to SEO DESCRIPTION option present in 

#   draft settings of a post in Hashnode editor.

# - You can also update a post to update this later.

seoDescription: 

 

# Disable comments for a post

# Boolean | Optional

# Default value: false // by default the comments will be enabled for the post.

# Ex: true

# - This is equivalent to "DISABLE COMMENTS" option present in 

#   draft settings of a post in Hashnode editor.

# - You can also update a post to enable/disable this later.

disableComments: 

 

# Slug of the series that you want your post to be a part of

# String | Optional

# Ex: react-series

# - This is equivalent to "ADD TO A SERIES" option present in 

#   draft settings of a post in Hashnode editor.

# - If invalid series is given, the post will not be added to any series.

# - You can update the post again to correct it later.

# - You can find series information from the series section in your publication dashboard. 

#   You can also edit the series information from there.

seriesSlug: // slug of the series

 

# Table of contents

# Boolean | Optional

# Default value: false // by default the table of contents will not be added to the post.

# Ex: true

# - This is equivalent to "GENERATE TABLE OF CONTENTS" option 

#   present in draft settings of a post in Hashnode editor.

# - If true, the table of contents will be added to the post.

# - You can also update a post to enable/disable this later.

enableToc: 

 

# Save post as draft

# Boolean | Optional

# Default value: false // by default the post will be published.

# Ex: true

# - If true, the post will be saved as a draft.

# - You can also update a draft with all the above attributes.

# - This draft will be available under Drafts section of the 

#   left sidebar in your publication dashboard.

# - Note: Once you remove this attribute, the post will be 

#   published and removed from drafts automatically.

# - This follows the same rules as a post create and update

#   flow as well as the slug rules mentioned since 

#   beginning of this manual.

saveAsDraft: 

 

 

# Note:

# This is in beta currently

# Newsletter and Post scheduling is NOT supported as of now.

 

---

```        

*   List of tags can be found here https://github.com/Hashnode/support/blob/main/misc/tags.json

*   Make sure you haven't included **ignorePost** in the frontmatter by mistake.

*   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).

*   You cannot create a new draft or a post with already published slugs

*   Do note that maximum of 10 file changes are respected in one particular commit.