From 5545afbd4aabc3e4a35d17db8045b452bef19be4 Mon Sep 17 00:00:00 2001 From: realaravinth Date: Mon, 18 Apr 2022 02:19:32 +0530 Subject: [PATCH] feat: docs to publish new bog post --- docs/new-blog.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/new-blog.md diff --git a/docs/new-blog.md b/docs/new-blog.md new file mode 100644 index 0000000..4627db8 --- /dev/null +++ b/docs/new-blog.md @@ -0,0 +1,37 @@ +# Add new blog post + +1. Create new file at `/content/blog/yyyy-mm-dd-blog-post-title.md` and + populate with the following metadata: + +```toml ++++ +title = "title of your blog post" +date = "yyyy-mm-dd" +description = "description of your blog post, will be displayed in blog listing" + +[taxonomies] +tags = ['tags', 'docs', 'rant'] + +[extra] +# **Only use author nicks in blog post Markdown files, it is used to lookup author details.** +author = 'imbatman' # author nickname ++++ +``` + +2. Add author details in [`config.toml`](../config.toml) in `authors` + under `extra` section: + + ```toml + [extra] + # Put all your custom variables here + authors = [ + { "nick"="imbatman", name="Batman", "website"="https://batman.example.org" }, + { "nick"="superman", name="Superman", "website" ="https://superman.example.org" } + ] + ``` + +This information is used to render author information in blog posts. +**Only use author nicks in blog post Markdown files, it is used to +lookup author details.** + +3. Add content to your blog post file, save and commit! 🎉