https://github.com/apple/swift-internals

https://github.com/apple/swift-internals

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/apple/swift-internals
• Owner: apple
• License: other
• Archived: true
• Created: 2016-01-21T22:32:14.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2022-06-10T06:06:42.000Z (over 2 years ago)
• Last Synced: 2024-06-11T04:31:19.952Z (3 months ago)
• Language: HTML
• Size: 121 KB
• Stars: 182
• Watchers: 126
• Forks: 70
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
## ⚠️ This repository has been archived. 

This repository has been migrated to https://github.com/apple/swift-org-website.

# Swift Internals

This is the source for the

[Swift Internals](http://apple.github.io/swift-internals) website,

which hosts internal documentation for the Swift compiler and

standard library, as well as the

[Swift API Guidelines](https://swift.org/documentation/api-design-guidelines.html).,

which are automatically regenerated from [this source](https://github.com/apple/swift-internals/tree/gh-pages/api-design-guidelines).

## Local Testing and Development

1. Have Ruby >= 2.0.0 installed.

2. `gem install bundler`—this command must normally be run with

   sudo/root/admin privileges.

3. `bundle install`—run this command as a regular, unprivileged user.

4. `LC_ALL=en_us.UTF-8 bundle exec jekyll serve --baseurl /swift-internals`

5. Visit [http://localhost:4000/swift-internals/](http://localhost:4000/swift-internals/).

6. Make edits to the source, refresh your browser, lather, rinse, repeat.

Notes: 

* Changes to `_config.yml` require restarting the local server (step 4

  above).

* If you make changes to `_config.yml` specifically in order to serve

  these pages from an address other than

  http://apple.github.io/swift-internals, please make sure those

  changes are not included in any pull requests, so we don't

  inadvertently break the main site.