Official Website of libimobiledevice

Contains the sources to generate the official website of libimobiledevice.

About

This repository contains the content, assets and logic to generate the official website for the libimobiledevice project. It is automatically build and deployed on changes pushed to the master branch or new releases related to the project.

The main purpose is to provide a central hub to learn about and to download libimobiledevice and related components.

Brief technology outline:

Static website generated using Cecil
Twig HTML templates using Bootstrap
Responsive design optimized for mobile, tablet and desktop
SASS based styles and optimized assets pipeline
Icons by Font Awesome
Syntax highlighting by Prism
Dynamic content based on GitHub API data
Automatically deployed using a GitHub Actions workflow for GitHub Pages
Hero animation using CSS and SVG image
Various CSS animations by animate-sass

Getting Started

Clone the actual project repository:

git clone https://github.com/libimobiledevice/libimobiledevice.org.git
cd libimobiledevice.org

Build the development version:

make development

This should install the dependencies and finally build the website into a public/ directory. Use your favourite browser to open public/index.html.

Live-rebuild run of development version:

make watch

This should install the dependencies, build the website and run a local webserver at http://localhost:8000 to view the result.

Any changes to the content, assets and other files should trigger a rebuild and a refresh of the website.

Contributing

We welcome contributions from anyone and are grateful for every pull request!

If you'd like to contribute, please fork the master branch, change, commit and send a pull request for review. Once approved it can be merged into the main code base.

If you plan to contribute larger changes or a major refactoring, please create a ticket first to discuss the idea upfront to ensure less effort for everyone.

Please make sure your contribution adheres to:

Try to follow the code style of the project
Commit messages should describe the change well without being to short
Try to split larger changes into individual commits of a common domain
Use your real name and a valid email address for your commits

We are still working on the guidelines so bear with us!

License

This website and assets are licensed under the GNU Affero General Public License v3, also included in the repository in the LICENSE file.

Credits

Apple, iPhone, iPad, iPod, iPod Touch, Apple TV, Apple Watch, Mac, iOS, iPadOS, tvOS, watchOS, and macOS are trademarks of Apple Inc.

Logo, Artwork & UI by Martin Szulecki.

This project is an independent software and has not been authorized, sponsored, or otherwise approved by Apple Inc.

README Updated on: 2020-09-27