Nationalsecurityagency.github.io

Theme by Nationalsecurityagency

|

Updated: 25 Nov 2024

|

288 Stars

Site for NSA's Open Source project listing

Overview

The code.nsa.gov website is built using the 18F/uswds Jekyll theme and is licensed under the Apache License. It is a useful resource for developers, maintainers, and contributors who are interested in exploring and contributing to NSA’s cybersecurity projects.

Features

• Integration with the U.S. Web Design System (USWDS)
• Easy editing of the main image and featured repo through the pages/index.md file
• Customization of the header and footer links through the data/navigation.yml file
• Addition or removal of the top usa-banner, logo image, and link information through the data/header.yml file
• Modification of the footer heading, contact information, social links, footer logo, and return to top link through the data/footer.yml file
• Ability to add repositories outside of NSAcyber organization through the data/temp.json file

Installation

To install the code.nsa.gov theme, follow these steps:

1. Clone the 18F/uswds Jekyll theme repository.

git clone https://github.com/18F/uswds-jekyll.git

2. Access the cloned repository.

cd uswds-jekyll

3. Copy the theme files to your desired location.

cp -r ./* /path/to/your/project

4. Edit the necessary files to customize the theme, such as pages/index.md, data/navigation.yml, data/header.yml, data/footer.yml, and data/temp.json.

5. Build and run your Jekyll project.

bundle install
jekyll serve

6. Access the site on your local server at http://localhost:4000.

Summary

The code.nsa.gov website is based on the 18F/uswds Jekyll theme and provides a platform for exploring and contributing to NSA’s cybersecurity projects. It offers various customization options for editing the main image, featured repo, header and footer links, and other site elements. By following the installation steps, users can easily set up and personalize the theme for their own projects.