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]>
scientific-python · Nov 21, 2024 · b3fc1e0 · b3fc1e0
1 parent 487192d
commit b3fc1e0
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 4 deletions.
diff --git a/doc/content/user_guide/getstarted.md b/doc/content/user_guide/getstarted.md
@@ -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)
    ```

diff --git a/exampleSite b/exampleSite
diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml
@@ -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
+      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:
diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md
@@ -0,0 +1,3 @@
+---
+title:
+---
-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    ---
+    title:
+    ---