Skip to content

Commit

Permalink
Remove submodules remark from README
Browse files Browse the repository at this point in the history
  • Loading branch information
kallies committed Oct 16, 2024
1 parent 0364944 commit e066402
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,14 @@ The main part are the labs, which can be found at [content/en/docs](content/en/d

This site is built using the static page generator [Hugo](https://gohugo.io/).

The page uses the [docsy theme](https://github.com/google/docsy) which is included as a Git Submodule.
The page uses the [docsy theme](https://github.com/google/docsy).
Docsy is being enhanced using [docsy-plus](https://github.com/acend/docsy-plus/) as well as [docsy-puzzle](https://github.com/puzzle/docsy-puzzle/).

After cloning the main repo, you need to initialize the submodules:

```bash
git submodule update --init --recursive
```

In order to update all submodules, run the following command:

```bash
git pull --recurse-submodules
```

### Docsy Theme Usage

* [Official docsy documentation](https://www.docsy.dev/docs/)
* [Docsy Plus](https://github.com/acend/docsy-plus/)

### Update submodules for theme updates

Run the following command to update all submodules with their newest upstream version:

```bash
git submodule update --remote
```

## Build using Docker

Build the image:
Expand Down

0 comments on commit e066402

Please sign in to comment.