search

nivenly / website

Apache License 2.0
5 stars 22 forks source link

readme

The Nivenly Foundation Resources Website

Here is the static website that is hosted at nivenly.org.

Building The Website

Clone the repository

git clone git@github.com:nivenly/website.git
cd website
make hugo

Running The Website

The site is built with Hugo and also requires Go, as indicated above. Hugo Installation instructions are here (Note: if you are using macOS you can install Hugo with brew.)

Once you have hugo, run the following command in the root directory of the repository to start the development server.

make dev

The first time you run the command will take a little bit while it downloads some necessities. Once it's running, the dev site is available at localhost:1313.

Adding a new page to the web site

Due to the choice of theme, using hugo new doesn't work quite as expected. Instead, please utilize one of the templates

All of our pages are going into English first, but may be translated into other languages. To create the file in the correct file path:

  1. All content should be in the content/en parent directory.
  2. In order to create a new page for the parent level of the left navigation panel, then the file should be in content/en/$NEWPARENTDIR/_index.md
  3. If you are planning to add sub-items to an existing parent level menu item, then it should be in content/en/$EXISTINGPARENTDIR/filename.md
  4. Note all $PARENTDIR require a minimum of an _index.md file.

Templates

Templates can be found in the templates directory

Basic Template

This template should be utilized for content written in markdown that does not need any custom markup or fomatting.

Advanced Template

The template should be utilized for content written in html that does need custom markup or formatting. (ie, custom classes, grids instead of tables, etc.)

Navigation Bar

To add a page to the nav bar, please add the following information into the header under the linkTitle

+++
[menu.main]
weight = 20
pre = "<i class='fas fa-people-group pr-2'></i>"
+++

The weight field determines what order the menu items appear on the nav menu. By default, all files with the same weight are alphabetized. All files added to the parent nav menu should have a weight: 4 and all sub-items should have a weight: 20.

The pre field adds the font awesome icon before the link in the menu

Shortcodes

Shortcodes are reusable components that can easily be embedded. These shortcodes can either contain static html code or it can have parameters that can be used to update the class, id, etc.

For example, the list of projects resides on both the homepage and on a separate projects page. A shortcode was generated so that the projects lists can be maintained from a single location.

Shared components reside in layouts/shortcodes/shared directory.

When utilizing a shortcode, please ensure that you utilize the {{% shared/name_here %}} format.