masnick / FSHSchool-site

Hugo source files for the FSHSchool site

FSH School

The FSH School website is built using Hugo and deployed to http://fshschool.org/ and https://fshschool.github.io/ via GitHub Actions that build the site and push its contents to the FSHSchool.github.io repository.

Local Development

To develop this site locally:

1. Clone this repository

   $ git clone [e-mail]:FSHSchool/site.git

   and add submodules

   $ git submodule update --init --recursive

2. Install Hugo
3. Add and edit content, refferring to the Hugo documentation as needed
4. Run the Hugo server

   $ hugo server

   NOTE: Optionally use the -D flag to include draft content
5. View the local site in your browser at http://localhost:1313/

Local Build

To do a local build (i.e., build the static site files without serving them), you will additionally need to install the postcss-cli and autoprefixer node modules. You can install them locally or globally:

$ npm install postcss-cli autoprefixer

or

$ npm -g install postcss-cli autoprefixer

Then run hugo with no arguments:

$ hugo

This will build the static site files to the ./public folder. They can then be served using any standard HTTP server.

License

Copyright 2020+ The MITRE Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.