HTML Website Template

Use this template as a starting point for any static HTML website project that you want other people to collaborate on.

STATUS: This project is actively used in production environments.

Features

Your new HTML website will immediately have publishable and documented code, and all these features:

• Deploy automatically using GitHub Pages
• Test locally with VS Code and the Tasks feature (uses rake behind scenes)
• Clean folder structure
• Automatic testing using GitHub Actions
• Tests for broken links, broken HTML and other problems
• HTTPS by default
• Documentation for contributors

How to use this

First clone or download a release, that is the starting point for your site.

THIS LIST IS EASY, CHECK IT OFF ONE-BY-ONE BABY!

• Open index.html in your favorite text editor and make a great web page, add other content if necessary.
• Fix all validation testing errors (see Build instructions, below)
• Upload your website source code to GitHub or other collaboration point
• Replace all details below, inspire people to contribute to your project.
• Update the release script in Rakefile with details to publish to your server.
• Delete all this crap up here.
• Publish the site (full steps are under Deploy below in case you forget)
• Set up HTTPS on your website, some hints are here

THEN YOU'RE DONE, GO STAR html-website-template FOR UPDATES.

My First Website About Horses

This website is published at https://example.com/horses/

Mission

This website exists to help educate the world about horses. There are so many kinds of horses and they are all just so magical. After you read these pages you will definitely want to get one for yourself!

Build instructions

We test and publish this website using a few simple tools. Please set up these tools (takes about 3 minutes) to contribute seriously to our project:

1. Set up Ruby on your system
   • For macOS, open Terminal.app and paste in these commands
     • Install Homebrew (click the link and paste that one command into Terminal.app)
     • brew install ruby
   • For Linux Mint, open Terminal and paste in these commands
     • sudo apt-get install ruby-dev build-essential libxml2 libxslt-dev libcurl4-openssl-dev
2. gem update --system
3. gem install bundler
4. export NOKOGIRI_USE_SYSTEM_LIBRARIES=true
5. bundle install

Now you are done setting up. Use this command to build the website.

bundle exec rake build

You can now access the website by pointing your browser to the BUILD folder or running a command like cd BUILD; php -S localhost:8000.

Also, you can check for common problems on our website automatically, just run this command.

bundle exec rake test

Deploy instructions

Use this command to publish the website online to our server.

bundle exec rake publish

You can only run that command if you have authorized SSH keys on your computer.

Author

Mary Smith and other contributors made this website with love.

License

Copyright 2017 Mary Smith. All rights reserved.