Landing page for sandpiper project

We use Hugo to build the Sandpiper website with the beautiful Docsy theme for content styling.

We host this website on Render with automatic https certificate updates and automatic updates from GitHub master. The render url is https://sandpiper.onrender.com/, but our own custom domain is https://sandpiperframework.org. We also use a Render feature that creates a unique url to review pull requests before merging to master.

Since the Docsy theme is included as a Git submodule, you must update from that repo to get all required files.

cd themes/docsy && git submodule update -f --init && cd ../.. && hugo --gc --minify 

1. This project requires Hugo "extended version" (0.53 or later) which supports SCCS. Look for hugo_extended_ at bottom of the Assets list:

https://github.com/gohugoio/hugo/releases 

There are no other dependencies. Simply save the executable to a directory in your PATH and you should be good to go!

2. If you want to add or override any css settings, you must install Nodejs and PostCSS. Hugo will take it from there. For more information, see the theme's instructions.

3. Make a local working copy using git (leaving off a target directory will create sandpiper-web automatically):

git clone https://github.com/sandpiper-framework/sandpiper-web.git 

4. Change directory to the root of the cloned project:

cd sandpiper-web 

5. Get local copies of the Docsy theme submodules so you can build and run your site locally:

git submodule update --init --recursive 

6. Build your site (to the /public directory). This also creates the local Lunr search index file:

hugo 

7. Preview your site locally using hugo server at: http://localhost:1313/. (Ctrl-C will stop the Hugo server).

All text content (beyond what is embedded in the theme design and overridden by The Sandpiper Authors) is maintained in markdown (.md) files inside language-specific content directories (e.g. content/en/). Files in these content directories are typically grouped in subdirectories corresponding to your site’s sections and templates. You can find more information here.

Images defined using Markdown should be saved to the site’s static directory. URLs then become relative to that directory. For example, a reference to image.png in the static directory would be /image.png.

![alt text](/image.png) or <img src="/image.png" alt="alt text"/> 

If you need more control over scaling and sizing, you can use the Docsy imgproc "shortcode" as shown here:

{{< imgproc spruce Fill "400x450" >}} Norway Spruce Picea abies shoot with foliage buds. {{< /imgproc >}} 

When using the imgproc shortcode, save the image in the associated Page Bundle which is usually the same directory as the _index.md file.

See the LICENSE file for details.

• Home page & About page image by Ray Hennessy https://unsplash.com/photos/BR2rEWcQQJQ
• The Sandpiper logo and mascot images are Copyright 2020 Megan Winsby. Used with permission.