Skip to content

Commit b3fc1e0

Browse files
Add basic example site (#653)
* Add basic example site * Update doc/content/user_guide/getstarted.md Co-authored-by: Stefan van der Walt <[email protected]> * Update --------- Co-authored-by: Stefan van der Walt <[email protected]>
1 parent 487192d commit b3fc1e0

File tree

4 files changed

+66
-4
lines changed

4 files changed

+66
-4
lines changed

doc/content/user_guide/getstarted.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ This theme is designed to be used as a Git submodule inside your site's source r
3939
git submodule add https://github.com/scientific-python/scientific-python-hugo-theme themes/scientific-python-hugo-theme
4040
```
4141

42-
3. Copy the theme's documentation site as a template for your site:
42+
3. Copy the theme's example site as a template:
4343

4444
```sh
45-
cp -a themes/scientific-python-hugo-theme/doc/* .
45+
cp -a themes/scientific-python-hugo-theme/exampleSite/* .
4646
```
4747

4848
4. Test the site:
4949

5050
```
51-
$ make serve
51+
$ hugo server
5252
...
5353
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
5454
```

exampleSite

Lines changed: 0 additions & 1 deletion
This file was deleted.

exampleSite/config.yaml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
baseURL: "https://example.com/"
2+
languageCode: "en-us"
3+
title: "Example Site"
4+
theme: scientific-python-hugo-theme
5+
relativeURLs: true
6+
disableKinds: ["taxonomy"]
7+
8+
markup:
9+
highlight:
10+
noClasses: false
11+
goldmark:
12+
renderer:
13+
unsafe: true
14+
renderHooks:
15+
link:
16+
enableDefault: true
17+
18+
params:
19+
author:
20+
name: "Example Team"
21+
description: "Example"
22+
images:
23+
- /images/logo.svg
24+
search: true
25+
navbarlogo:
26+
image: logo.svg
27+
text: Scientific Python Hugo Theme
28+
link: /
29+
fonts:
30+
- name: "Lato"
31+
weights: [400, 900]
32+
hero:
33+
title: Example Site
34+
image: logo.svg
35+
buttontext: Get Started
36+
buttonlink: "#"
37+
navbar:
38+
- title: User Guide
39+
url: /
40+
footer:
41+
logo: logo.svg
42+
socialmediatitle: ""
43+
socialmedia:
44+
- link: https://github.com/
45+
icon: github
46+
47+
quicklinks:
48+
column1:
49+
title: ""
50+
links:
51+
- text: About
52+
link: /
53+
- text: Theme GitHub
54+
link: https://github.com/scientific-python/scientific-python-hugo-theme
55+
column2:
56+
links:
57+
- text: Scientific Python Forum
58+
link: https://discuss.scientific-python.org
59+
column3:
60+
links:

exampleSite/content/_index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title:
3+
---

0 commit comments

Comments
 (0)