Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 1.8 KB

README.md

File metadata and controls

52 lines (31 loc) · 1.8 KB
Raw

Bottlerocket Project Website

This repository is the source to the Bottlerocket project website. It contains the content (as Markdown files), templates (HTML), stylesheets (CSS), and Hugo configurations (mostly TOML, some YAML).

Contributing

The Bottlerocket website is open to contribution and collaboration. See CONTRIBUTING for specific instructions.

Rendering Locally

This site uses Hugo for rendering. You may run hugo locally to validate your changes render properly.

Rendering

If hugo is installed, you may view the rendered site by running:

# To render everything, including draft posts
hugo server -D

# To render the site as it will appear when being published
hugo server

If you use make, have docker, and do not have hugo installed, you may also use the following make target as a convenience:

make preview

Hugo Installation

Hugo is available for many platforms.

  • Linux: most native package managers
  • macOS: brew install hugo
  • Windows: choco install hugo

See the Hugo installation instructions for additional options.

Security

See CONTRIBUTING for more information.

License Summary

Site templates, source code, and stylesheets are made available under the Apache 2.0 license. See the LICENSE file.

The content and documenation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE-CONTENT file.

The sample code within this documentation is made available under a modified MIT-0 license. See the LICENSE-SAMPLECODE file.