diff options
author | Darshan Baral <darshanbaral@gmail.com> | 2019-05-19 04:57:03 +0300 |
---|---|---|
committer | Darshan Baral <darshanbaral@gmail.com> | 2019-05-19 04:57:03 +0300 |
commit | 70d054494cf5e6878a1ed702852ecb2065116592 (patch) | |
tree | 3cfe27855ca1d2eaca652c0c048a675d0cfb52a2 | |
parent | 0b618303dc9950d045df8c8d49369b76739934d9 (diff) |
Modified README
-rw-r--r-- | README.md | 27 | ||||
-rw-r--r-- | theme.toml | 4 |
2 files changed, 27 insertions, 4 deletions
@@ -1,2 +1,25 @@ -# kitab -A hugo theme for publishing books +# kitab theme + +The kitab Theme is a simple theme meant for publishing books. + +## 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](//gohugo.io/overview/installing/) 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`](https://github.com/darshanbaral/kitab/blob/master/exampleSite/config.toml). Copy the `config.toml`to 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, and date. @@ -1,8 +1,8 @@ name = "kitab" license = "MIT" -licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE" +licenselink = "https://github.com/darshanbaral/kitab/blob/master/LICENSE" description = "A hugo theme for publishing books" -homepage = "" +homepage = "https://github.com/darshanbaral/kitab" tags = ["book"] features = ["minimal", "responsive"] min_version = "0.41" |