# swift-org-website

**Repository Path**: mirrors_apple/swift-org-website

## Basic Information

- **Project Name**: swift-org-website
- **Description**: Swift.org website
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-17
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Swift.org Website

## Overview

Swift.org website goals include:

1. Welcome the curious about the Swift programming language.
2. Share knowledge with the Swift users community and prospective users, including instructions for getting started with Swift as easily as possible, user guides, best practices, API documentation and feature announcements.
3. Share knowledge with the Swift contributors community and prospective contributors, including contribution guides, technical details that assist contributions, project governance and legal information.
4. Highlight community driven initiatives and technical work that have broad applicability to Swift users in all or some of its core usage domains.

See [website overview](/website) for more information about the Swift.org website goals, content governance and contribution guidelines.

## Technical

Swift.org uses [Jekyll](https://jekyllrb.com), a blog-aware, static site generator in Ruby.

### Running locally

Requirements
- Git
- Ruby 3.3 or higher
  _(a Ruby installation manager, such as
  [rbenv](https://github.com/sstephenson/rbenv) or
  [RVM](https://rvm.io) is recommended, but not required)_
- [Bundler](https://bundler.io/)

To run the site locally, enter the following commands into a terminal window:

```shell
git clone https://github.com/swiftlang/swift-org-website.git
cd swift-org-website
bundle install
LC_ALL=en_us.UTF-8 bundle exec jekyll serve --config _config.yml,_config_dev.yml
open "http://localhost:4000"
```

If you’d like to contribute to this project, please run Prettier before submitting your pull request to ensure consistent code style across the project.

Requirements
- [Node v18.17.1 or higher](https://nodejs.org)

```shell
npm install
```

```shell
npm run prettify
```

### Running with Apple Container

On macOS 26 and later, you can use the [Apple Container](https://github.com/apple/container) tool to host and run the website.

First install and run `container`:

```shell
brew install container
brew services start container
```

Then build and run the site:

```shell
make build
make website
```

The website will be available at `http://localhost:4000`

### Running in Docker

First build the site with Docker Compose:

```bash
docker compose run build
```

Then you can run the site:

```bash
docker compose up website
```

The website will be available on `http://localhost:4000`