Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic example site #653

Merged
merged 3 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/content/user_guide/getstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,16 @@ This theme is designed to be used as a Git submodule inside your site's source r
git submodule add https://github.com/scientific-python/scientific-python-hugo-theme themes/scientific-python-hugo-theme
```

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

```sh
cp -a themes/scientific-python-hugo-theme/doc/* .
cp -a themes/scientific-python-hugo-theme/exampleSite/* .
```

4. Test the site:

```
$ make serve
$ hugo server
...
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
```
Expand Down
1 change: 0 additions & 1 deletion exampleSite

This file was deleted.

60 changes: 60 additions & 0 deletions exampleSite/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
baseURL: "https://example.com/"
languageCode: "en-us"
title: "Example Site"
theme: scientific-python-hugo-theme
relativeURLs: true
disableKinds: ["taxonomy"]

markup:
highlight:
noClasses: false
goldmark:
renderer:
unsafe: true
renderHooks:
link:
enableDefault: true

params:
author:
name: "Example Team"
description: "Example"
images:
- /images/logo.svg
search: true
navbarlogo:
image: logo.svg
text: Scientific Python Hugo Theme
link: /
fonts:
- name: "Lato"
weights: [400, 900]
hero:
title: Example Site
image: logo.svg
buttontext: Get Started
buttonlink: "#"
navbar:
- title: User Guide
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe another link here? Or at least one that resolves to something meaningful.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can clean this up later. For now, I just want to make sure we aren't asking folks to copy a ton of stuff they need to delete.

url: /
footer:
logo: logo.svg
socialmediatitle: ""
socialmedia:
- link: https://github.com/
icon: github

quicklinks:
column1:
title: ""
links:
- text: About
link: /
- text: Theme GitHub
link: https://github.com/scientific-python/scientific-python-hugo-theme
column2:
links:
- text: Scientific Python Forum
link: https://discuss.scientific-python.org
column3:
links:
3 changes: 3 additions & 0 deletions exampleSite/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title:
---