Skip to content

Markdown supported, Dynamic personal blog hosted on github.

License

Notifications You must be signed in to change notification settings

samiurprapon/blog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

80 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Personal Blog ⚡️ Actions Status: deployment

Multipurpose blog to share my views on technology, research, innovations and what I will explore in the near future.

🔗 Live Demo

Here's a live demo

Github Issues / Blogs


Getting Started 🚀

Development Environment

  • node.js 14.X
  • yarn 1.22.X

Installing & Configuration

0. Clone this repository

$ git clone https://github.com/samiurprapon/blog.git

1. Go into the repository

$ cd blog

2. Install dependencies

$ yarn install

3. Generate a Github Personal Access Token.

Generate a Github personal access token using these Instructions or simply go and generate from here.

Make sure you don't select any scope just generate a simple token without any scope

After that copy your generated token and then encode your token into base 64 using this Website

Copy your base64 converted token

4. Change /src/config.js.

Go to your cloned repository and make the following changes in /src/config.js

const config = {
  // Github Converted Token (User, repo) from -> https://www.utilities-online.info/base64
  githubConvertedToken: "Your access token here",

  // Github UserName
  githubUserName: "Your github username here",

  // Github Repo Name
  githubRepo: "Your repo's name here",

  // Personal Blog Title
  title: "Title of your blog",

  // Personal Blog Subtitle
  subtitle: "Subtitle of your blog",
};

5. Write A Blog.

After doing following changes now you just need to write a blog on repository issues that you have mentioned in your config.js

  • Open your repository github issues
  • Create a new issue with categorical labels
  • Now write your blog in github issue in markdown. You can also use slack edit to write your markdown
  • Add a label blog on your github issue to make it different from other standard issues. Keep in mind blog label is mandatory otherwise it won't show on your website.

6. Deploy

  1. Build webpage
$ yarn run build
  1. Deploy on github
$ yarn run deploy
  1. Go to https://github.com/<your-username>/<your-repo-name>/settings/secrets/actions , click New repository secret and add a secret named as ACCESS_TOKEN and paste your previously generated Github Personal Access Token as value.
  2. Change .github/workflows/deploy.yml.
git config --global user.email "your-github-mail-address"
git config --global user.name "your-github-username"
git remote set-url origin https://${{secrets.ACCESS_TOKEN}}@github.com/<your-github-username>/<your-repo-name>.git

Contribution

I highly encourage the community to step forward and improve this project further. You can fix any reported bug, propose or implement new features, write tests, etc.

Pull requests are welcome! See the contributor guidelines for more details.

License License: GPL v2

Copyright 2021 Samiur Prapon

Licensed under the GNU General Public License, Version 2.0 (the "License");
You may obtain a copy of the License at

   https://github.com/samiurprapon/blog/blob/main/LICENSE

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

About

Markdown supported, Dynamic personal blog hosted on github.

Resources

License

Code of conduct

Stars

Watchers

Forks