Use Atomix

Using Atomix

Development

Atomix is available in three different ways, each with its own advantages. You can choose the method that best suits your workflow.


The fastest and easiest way to use Atomix is by adding a single line of code to your HTML <head> section:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/enioaiello/atomix/dist/atomix.min.css">

✅ Advantages:

  • Instant setup – No installation required.

  • Automatic updates – Always uses the latest version when a new commit is made.

  • No impact on custom CSS – Since Atomix is loaded first, it won't override your styles due to CSS priority rules.

⚠️ Potential drawbacks:

  • Automatic updates can cause issues – If a new update modifies class names, it might break some styles.

  • Risk of incomplete updates – If an error occurs in the latest commit, your site may load an unstable version.

Once added, Atomix is ready to use! You can explore the documentation here to start building with it.


2️⃣ Downloading a Release

This method provides a static version of Atomix, similar to cloning the repository, but without Git integration. You will need to update it manually whenever a new version is available.

Steps:

  1. Visit the latest release page and download the CSS file.

  2. Place the file in your project's assets folder.

  3. Link it in your HTML just like a regular CSS file:

<link rel="stylesheet" href="assets/css/atomix.min.css">

✅ Advantages:

  • More control – You decide when to update.

  • Stable version – Your styles won’t break due to unexpected updates.

🔄 Updating:

  • To update Atomix, simply download the latest release and replace the old file.

  • If you prefer an older version, visit the all releases page to find previous versions.


3️⃣ Cloning the Repository

For full access to Atomix, including source files and SCSS, you can clone the GitHub repository:

git clone https://github.com/enioaiello/atomix.git

This method is ideal if you want to:

  • Customize Atomix’s source code.

  • Contribute to its development.

  • Work with SCSS instead of the compiled CSS file.


🎯 Which method should you choose?

Method
Best for...
Updates Automatically?
Requires Manual Setup?

CDN (Recommended)

Quick setup, always up-to-date

✅ Yes

❌ No

Releases

Stability, controlled updates

❌ No

✅ Yes

Clone Repo

Customization, contributing

❌ No

✅ Yes


🚀 Now that Atomix is installed, you're ready to start designing! Check out the documentation for usage details.

Last updated