Skip to content

Commit 0f12363

Browse files
committed
Update readme to include submodule (theme)
1 parent dfc4002 commit 0f12363

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,19 @@ The [FAIR Data Pipeline website](https://www.fairdatapipeline.org/) contains inf
77

88
* [FairDataPipeline/fairdatapipeline.github.io](https://github.com/FAIRDataPipeline/fairdatapipeline.github.io) contains website source files.
99

10-
* [ScottishCovidResponse/hugo-book](https://github.com/ScottishCovidResponse/hugo-book) contains Hugo theme files
10+
* [RyanJField/hugo-book](https://github.com/RyanJField/hugo-book) contains Hugo theme files
1111
* This theme is based on the Hugo [Book](https://github.com/alex-shpak/hugo-book) theme, with the search bar from the Jekyll [Just the Docs](https://github.com/pmarsceill/just-the-docs) theme, and some extra tweaks
12-
* Forked from [RyanJField/hugo-book](https://github.com/RyanJField/hugo-book)
12+
* It is included as a submodule
1313

1414
## How to edit the site
1515

1616
It is not necessary to build the site in order to contribute changes, but if you want to see how these will be rendered, you will need to cary out the folowing steps:
1717

1818
1. [Install `hugo extended`](https://gohugo.io/getting-started/installing/).
1919
2. Clone this repository `git clone https://github.com/FAIRDataPipeline/FDP_hugo.git`.
20-
3. Information regarding the directory structure of the website and how make edits to to the template (mostly in markdown) can be found [here](https://gohugo.io/getting-started).
21-
4. In the folder that contains this repository run the command `hugo server`.
22-
5. The website should build locally on http://localhost:1313/.
20+
3. Install the theme using the submodule: `git submodule update --init --recursive`.
21+
4. Information regarding the directory structure of the website and how make edits to to the template (mostly in markdown) can be found [here](https://gohugo.io/getting-started).
22+
5. In the folder that contains this repository run the command `hugo server`.
23+
6. The website should build locally on http://localhost:1313/.
2324

24-
After pushing to Github, source files should automatically be generated and the website should build online. Alternatively, click on the Edit this page link (at the bottom of each page, next to the pencil) to edit an existing page.. or email a markdown / word document and we'll put it up for you.
25+
After pushing to Github, source files should automatically be generated and the website should build online. Alternatively, click on the Edit this page link (at the bottom of each page, next to the pencil) to edit an existing page. or email a markdown / word document and we'll put it up for you.

0 commit comments

Comments
 (0)