Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/invinciblycool/lekh.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorinvinciblycool <jprrahultiwari@gmail.com>2021-05-02 11:51:10 +0300
committerinvinciblycool <jprrahultiwari@gmail.com>2021-05-02 11:51:10 +0300
commit5f5429c724cda435f05aeca4eb6d47590a801cb2 (patch)
treec242816ed8f04856fdd98b96ec9fb888850466ad
parent1b445a0c2613ea2ea25b213c48a9218c614bd5d2 (diff)
update docs and example config.toml
-rw-r--r--README.md68
-rw-r--r--exampleSite/config.toml14
-rw-r--r--theme.toml4
3 files changed, 55 insertions, 31 deletions
diff --git a/README.md b/README.md
index 5bf6f84..0d66ff6 100644
--- a/README.md
+++ b/README.md
@@ -15,19 +15,41 @@ Simple, text-focussed and minimal personal portfolio theme based on https://gith
## Installation
-cd into your hugo site's root directory and:
+### Installing Hugo
```sh
-cd themes
-git clone https://github.com/invinciblycool/lekh.git
+# For Linux
+sudo apt-get install hugo
+
+# For Mac
+brew install hugo
+
+# Detailed instructions at https://gohugo.io/getting-started/installing#readout
```
-For more information read the [official setup guide](https://gohugo.io/overview/installing/) of Hugo.
+### Creating a new site
+
+```sh
+hugo new site <site_name>
+```
+
+### Adding lekh as a theme
+
+```sh
+cd <site_name>
+git init
+git submodule add https://github.com/ba11b0y/lekh.git themes/lekh
+echo theme = \"lekh\" >> config.toml
+
+```
+
+Here's Hugo's [official guide](https://gohugo.io/getting-started/quick-start/) for more details.
## Personalization
-To personalize the theme
+Hugo looks for a `config.toml` in the root of your site.
+To personalize the theme, copy the default config shipped with the theme
`cp themes/lekh/exampleSite/config.toml config.toml`
@@ -37,29 +59,29 @@ Or simply copy the below config and customize accordingly.
```toml
-baseURL = "http://rtiwari.me/"
+baseURL = "https://example.com/"
languageCode = "en-us"
-title = "Rahul Tiwari"
+title = "Example Lekh Site"
theme = "lekh"
[params]
-Name = ""
-Email = ""
+Name = "Agent Smith"
+Email = "agentsmith@thematrix.com"
Resume = "" # Add the filename with file extension.
PostLimit = 4 # Sets the number of posts to display on the front page
GoatCounterCode = ""
[[params.profiles]]
name = "GitHub"
-url = ""
+url = "https://github.com/ba11b0y"
[[params.profiles]]
name = "Twitter"
-url = ""
+url = "https://twitter.com/ba11b0y"
[[params.profiles]]
name = "Goodreads"
-url = ""
+url = "https://www.goodreads.com/user/show/91520565-rahul-tiwari"
[[params.profiles]]
name = "LinkedIn"
@@ -67,20 +89,22 @@ url = ""
```
-## Posts
+## Creating posts
-Below is a typical post, which defaults to what Hugo expects.
+```sh
+# This creates a new draft post in content/posts
+hugo new posts/title-of-post.md
+```
-Specify `draft: true` to avoid publishing the post.
+## Serving it up
-```md
----
-title: "Rant post"
-date: "2020-04-02"
-draft: true
----
+```sh
+# This will show up your draft posts as well.
+hugo server -D
+#OR
-Too much to rant :(
+#This will show up only your published posts.
+hugo server
```
## Credits
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index aad1fb2..6361d51 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -1,26 +1,26 @@
-baseURL = "http://rtiwari.me/"
+baseURL = "https://example.com/"
languageCode = "en-us"
-title = "Rahul Tiwari"
+title = "Example Lekh Site"
theme = "lekh"
[params]
-Name = ""
-Email = ""
+Name = "Agent Smith"
+Email = "agentsmith@thematrix.com"
Resume = "" # Add the filename with file extension.
PostLimit = 4 # Sets the number of posts to display on the front page
GoatCounterCode = ""
[[params.profiles]]
name = "GitHub"
-url = ""
+url = "https://github.com/ba11b0y"
[[params.profiles]]
name = "Twitter"
-url = ""
+url = "https://twitter.com/ba11b0y"
[[params.profiles]]
name = "Goodreads"
-url = ""
+url = "https://www.goodreads.com/user/show/91520565-rahul-tiwari"
[[params.profiles]]
name = "LinkedIn"
diff --git a/theme.toml b/theme.toml
index af94204..8ad5bf2 100644
--- a/theme.toml
+++ b/theme.toml
@@ -1,8 +1,8 @@
name = "Lekh"
license = "MIT"
-licenselink = "https://github.com/invinciblycool/lekh/blob/master/LICENSE.md"
+licenselink = "https://github.com/ba11b0y/lekh/blob/master/LICENSE.md"
description = "A text focussed and minimal personal portfolio theme with dark mode."
-homepage = "https://github.com/invinciblycool/lekh"
+homepage = "https://github.com/ba11b0y/lekh"
tags = ["minimal", "clean", "blog", "responsive", "personal", "simple", "minimalist", "portfolio", "text-focussed", "dark", "dark-mode", "rss"]
features = ["blog", "Clean and minimal", "Responsive", "Social media links", "Markdown", "Text focussed", "Dark mode", "RSS feeds"]
min_version = "0.38"