From 73811bdb7aa251620850537fc8126d8a483462e9 Mon Sep 17 00:00:00 2001 From: welpo Date: Sun, 16 Apr 2023 16:34:12 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20minor=20changes=20to=20i?= =?UTF-8?q?nstallation=20instructions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 705ae0b..a3cd49b 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ See the project's roadmap [here](https://github.com/users/welpo/projects/1). ## Quick start ```bash -git clone git@github.com:welpo/tabi.git +git clone https://github.com/welpo/tabi.git cd tabi zola serve ``` @@ -42,6 +42,12 @@ Open http://127.0.0.1:1111/ in the browser. To add tabi to you existing Zola site: +0. Initialize a Git repository in your project directory (if you haven't already): + +``` +git init +``` + 1. Add the theme as a git submodule: ``` @@ -51,13 +57,15 @@ git submodule add https://github.com/welpo/tabi.git themes/tabi Or clone the theme into your themes directory: ``` -git clone https://github.com/welpo/tabi.git themes/tabi` +git clone https://github.com/welpo/tabi.git themes/tabi ``` +### Required configuration + 2. Enable the theme in your `config.toml`: ``` -theme = "tabi"` +theme = "tabi" ``` 3. Set a `title` in your `config.toml`: @@ -83,7 +91,7 @@ If you want to serve your blog posts from a different path, such as `blog/`, add section_path = "blog/_index.md" ``` -5. If you want an intro page (see screenshot above), add these lines to `content/_index.md`: +5. If you want an introduction section (see screenshot above), add these lines to `content/_index.md`: ``` [extra]