Giter Club home page Giter Club logo

blog-template's Introduction

Personal Blog Template

tl;dr

  1. Fork this repo
  2. Change name of repo
  3. edit ./config.md ./index.md ./_assets/favicon.png ./_assets/dp.webp
  4. use ./blog new
  5. use ./blog spcheck posts/filename.md
  6. use ./blog publish

For Dhruva alone, https://stackoverflow.com/a/30352360

What it is

This is a template for a Franklin.jl powered blog adapted from the hyde theme, but with a dark theme and some utils.jl and bash scripts to handle basic blog tasks

Grammar check

As part of the blogging process, most people tend to run their work through a third party spell/grammar check, but these services are either not free (as in libre and as beer), or worse, do not even integrate with text editors. Hence, I have added a utility julia script called LanguageTool.jl which uses a local LanguageTool server to check your code.

LanguageTool has support for (n)vim and vscodium(vscode), and supporting the plugin seems pointless.

Github action

The Franklin github action is used unchanged so that blog builds are done at every push.

Setup

Minimal

  1. Create a GitHub account

  2. Click the "Fork" button on the top right.

  3. This will open https://github.com/Your-User-Name/blog-template

  4. Click Settings and change the name of the repo to blog, or something of your choice. Your blog will then be hosted at https://Your-User-Name.github.io/reponame/

  5. On your laptop, install git

  6. Run git clone https://github.com/Your-User-Name/your-repo-name.git, which creates a connected copy of your blog for you to edit.

  7. cd your-repo-name

  8. edit ./config.md ./index.md ./_assets/favicon.png ./_assets/dp.webp and fill your info.

Complete

These steps are only necessary if you want to build the site locally or run spellcheck

  1. Do all steps as before until the second last step.
  2. Install julia.
  3. Run ./blog setupjl
  4. Run ./blog setuplt

Usage

  1. cd reponame
  2. ./blog new. DO NOT change the file name.
  3. Edit your blog post in Markdown
  4. ./blog publish

If you also want to build and see your site locally,

  1. ./blog serve

If you want to run spellcheck too,

  1. ./blog spcheck posts/filename.md

Happy Blogging!

If you decide to use my template, let me know! I'll link your blog on mine, and you do the same!

blog-template's People

Contributors

dhruvasambrani avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.