Coder Social home page Coder Social logo

kitab's Introduction

kitab theme

The kitab Theme is a simple theme meant for publishing books.

Demo

Click here for a live demo.

Installation

Inside the folder of your Hugo site run:

$ cd themes
$ git clone https://github.com/darshanbaral/kitab.git

For more information read the official setup guide of Hugo.

Getting started

After installing the kitab Theme successfully, modify the config.toml as you wish.

The config file

You'll find a file called config.toml. Copy the config.tomlto the root folder of your Hugo site and customize it per your need.

Adding books

  • Create a folder inside the content folder for each book
  • Add _index.md inside the folder for book with meta data such as book title, author, book cover image, and date.
  • Create a new file for each chapter of the book.

Book Cover Images

The book cover image can be specified in the _index.md of the section folder. If the book cover image is big in size, a copy that is reduced in size can be specified as a thumbnail. See the _index.md in exampleSite for example.

kitab's People

Contributors

darshanbaral avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

kitab's Issues

Include Book Cover on Homepage and a Book Description

Nice work with this theme, it was the only one that fit for a community site I have called Writing Buddies.

The only things missing from this theme are:

  1. Book covers on the homepage, and/or
  2. Book description.

I feel like there needs to be at least one or the other, both would be spectacular but if you decide not to I understand.

Still working on that one...

I uploaded book correctly and have seen books before I slept.
But on the next day, I find out the categories are there, but when check every single chapter, the page is showing "Still working on that one..."
a_screen_shot

Not having covers breaks site generation

If I attempt to create a _title.md file with the contents of:

+++ title = "Pride and Prejudice" author = "Jane Austen" date = "2019-05-12" weight = 3 bookCover = "bookCovers/pride_and_prejudice.jpg" +++

but I omit the book cover info (leaving me with)+++ title = "Pride and Prejudice" author = "Jane Austen" date = "2019-05-12" +++

I get the error EOF looking for end TOML front matter delimiter.

Is it possible to build without having the book cover info in the index? I don't have covers for any of my works, so that field isn't necessary.

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.