https://github.com/swiftlang/swift-org-website

Swift.org website
https://github.com/swiftlang/swift-org-website

Last synced: 10 days ago
JSON representation

Swift.org website

• Host: GitHub
• URL: https://github.com/swiftlang/swift-org-website
• Owner: swiftlang
• License: other
• Created: 2022-02-11T19:56:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T20:58:10.000Z (5 months ago)
• Last Synced: 2024-06-17T22:58:43.307Z (5 months ago)
• Language: SCSS
• Homepage: https://swift.org
• Size: 39.9 MB
• Stars: 452
• Watchers: 115
• Forks: 170
• Open Issues: 63
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Support: support/security.md

Awesome Lists containing this project

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

open "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`