Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 1.64 KB

README.md

File metadata and controls

52 lines (36 loc) · 1.64 KB
Raw

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 for more information about the Swift.org website goals, content governance and contribution guidelines.

Technical

Swift.org uses Jekyll, a blog-aware, static site generator in Ruby.

Running locally

Requirements

  • Git
  • Ruby 3.2 or higher (a Ruby installation manager, such as rbenv or RVM is recommended, but not required)
  • Bundler

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

git clone https://github.com/apple/swift-org-website.git
cd swift-org-website
bundle install
LC_ALL=en_us.UTF-8 bundle exec jekyll serve
open "http://localhost:4000"

Running in Docker

First build the site with Docker Compose:

docker-compose run build

Then you can run the site:

docker-compose up website

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