diff --git a/doc/content/user_guide/getstarted.md b/doc/content/user_guide/getstarted.md index c68749d0..21ed51ac 100644 --- 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 deleted file mode 120000 index 325ab0db..00000000 --- a/exampleSite +++ /dev/null @@ -1 +0,0 @@ -doc \ No newline at end of file diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml new file mode 100644 index 00000000..07650cb9 --- /dev/null +++ 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 new file mode 100644 index 00000000..18b63196 --- /dev/null +++ b/exampleSite/content/_index.md @@ -0,0 +1,3 @@ +--- +title: +---