diff --git a/README.md b/README.md index 9950ec2b..405d56dc 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ The Quick Start shows how to run the theme directly. Next we will use abridge as ### 1: Create a new zola site ```bash -zola init mysite +yes "" | zola init mysite cd mysite ``` @@ -82,6 +82,8 @@ Add the theme as a git submodule: ```bash git init # if your project is a git repository already, ignore this command git submodule add https://github.com/jieiku/abridge.git themes/abridge +git submodule update --init --recursive +git submodule update --remote --merge ``` Or clone the theme into your themes directory: @@ -95,16 +97,15 @@ git clone https://github.com/jieiku/abridge.git themes/abridge Copy some files from the theme directory to your project's root directory: ```bash -touch templates/.gitkeep +rsync themes/abridge/.gitignore .gitignore rsync themes/abridge/config.toml config.toml rsync themes/abridge/content/_index.md content/ -rsync themes/abridge/COPY-TO-ROOT-SASS/* sass/ +rsync -r themes/abridge/COPY-TO-ROOT-SASS/* sass/ rsync themes/abridge/netlify.toml netlify.toml rsync themes/abridge/package_abridge.js package_abridge.js rsync themes/abridge/package.json package.json ``` -- `templates/.gitkeep` the templates directory is required in your base site. [#2150](https://github.com/getzola/zola/issues/2150) - `config.toml` base configuration with all config values. - `content/_index.md` required to set pagination. - `COPY-TO-ROOT-SASS/abridge.scss` overrides to customize Abridge variables. diff --git a/content/overview-abridge/index.md b/content/overview-abridge/index.md index 4739a14e..0a306ccd 100644 --- a/content/overview-abridge/index.md +++ b/content/overview-abridge/index.md @@ -66,7 +66,7 @@ The Quick Start shows how to run the theme directly. Next we will use abridge as ### 1: Create a new zola site ```bash -zola init mysite +yes "" | zola init mysite cd mysite ``` @@ -77,6 +77,8 @@ Add the theme as a git submodule: ```bash git init # if your project is a git repository already, ignore this command git submodule add https://github.com/jieiku/abridge.git themes/abridge +git submodule update --init --recursive +git submodule update --remote --merge ``` Or clone the theme into your themes directory: @@ -90,16 +92,15 @@ git clone https://github.com/jieiku/abridge.git themes/abridge Copy some files from the theme directory to your project's root directory: ```bash -touch templates/.gitkeep +rsync themes/abridge/.gitignore .gitignore rsync themes/abridge/config.toml config.toml rsync themes/abridge/content/_index.md content/ -rsync themes/abridge/COPY-TO-ROOT-SASS/* sass/ +rsync -r themes/abridge/COPY-TO-ROOT-SASS/* sass/ rsync themes/abridge/netlify.toml netlify.toml rsync themes/abridge/package_abridge.js package_abridge.js rsync themes/abridge/package.json package.json ``` -- `templates/.gitkeep` the templates directory is required in your base site. [#2150](https://github.com/getzola/zola/issues/2150) - `config.toml` base configuration with all config values. - `content/_index.md` required to set pagination. - `COPY-TO-ROOT-SASS/abridge.scss` overrides to customize Abridge variables.