Git Product home page Git Product logo

twentytwenyonetheme's Introduction

Welcome to Twenty Twentyone

This is my first theme so please be kind! But do still also let me know if you have any questions.

What's this theme?

It's a simple theme heavily inspired by Ghost's default Casper theme. It is also an excuse to try TailwindCSS.

Features

  • TailwindCSS
    • PurgeCSS
    • Tailwind's Typograhy
    • Prism
  • NetlifyCMS
  • Hyvor Commenting System
  • Mathjax for writing math. I suggest you read this very helpful guide to get started
  • Mardown for content
  • HTML for template
  • Webpack

No Hassle way to start blogging!

Deploy to Netlify

Click this button and Netlify will do most of the hard work for you!

Preview the Theme

Setup Up Locally

  1. You can clone the repository :
git clone https://github.com/smolcodes/twentytwenyonetheme.git my-blog-name

(if you are unsure what that means here is a really good set of instructions)

  1. Go to your directory/folder
  2. Install dependencies npm install

Building the Site

  1. In the command line, still in the directory run the 11ty buid
npm run build:eleventy
  1. Run webpack
npm run webpack

Seeing the site live

run start

npm run start

Information to change

You will want to change the information in site.json which can be found in src>_data.

Hyvor

You'll need to change the ID code in post.html (which can be found in sr>_includes>layouts) if you want to use Hyvor Talk and you will also need to set up an account. Your Hyvor id will be on the General Settings Page of the Hyvor Dashboard.

NetlifyCMS

  1. Set up a netlify account if you do not already have one and add your repository to it, Here is a step by step guide
  2. In src>admin open config.yml in a text editor. Change the repo (repository) to your repository.
  3. In Netlify you will need to add github in identity>registrations

Final Notes

Go to tailwind.config to customize the styles. This template uses pre-flight.

Version 2

Now supports

  • Image shortcode using eleventy-img
  • HTML minifier
  • Markdown Callouts
  • Fixed all posts to NJK

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.