Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jieiku committed Jan 6, 2024
1 parent ae68172 commit db86259
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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:
Expand All @@ -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.
Expand Down
9 changes: 5 additions & 4 deletions content/overview-abridge/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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:
Expand All @@ -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.
Expand Down

0 comments on commit db86259

Please sign in to comment.