aegis-icons.github.io

Website for the icon set that has a very basic Jekyll setup.

Running the local test server

Setup

Get the icons

Note

Both aegis-icons.github.io & aegis-icons directories needs to be side by side in the same root directory.

• For Windows, run the 1__get_icons.bat script (in the z__bat-scripts dir).
• For Linux (with bash), run the 1__get_icons.sh script (in the z__sh-scripts dir).
  • Give permissions first:

    chmod +x 1__get_icons.sh

• For other OSes / manual way, copy-paste icons folder from aegis-icons dir to website root, then rename folders:
  • 1_Primary ➜ p
  • 2_Variations ➜ v
  • 3_Generic ➜ g

Remember, if you want the latest icons to the site, you'll need to do these steps again.

Installations

1. Install Ruby, Bundler & Jekyll with guides here.
2. Run bundle install in the terminal at site's root directory.

Important

For setups older then 2026-04-05, you'll need to do the setup again because of jekyll to github-pages gem change.

Run these in the terminal at site's root directory to reinstall:

bundle clean --force
bundle install

Start the server

• For Windows, run the 2__start_jekyll_server.bat script (in the z__bat-scripts dir).
• For Linux (with bash), run the 2__start_jekyll_server.sh script (in the z__sh-scripts dir).
  • Give permissions first:

    chmod +x 2__start_jekyll_server.sh

• For other OSes / manual way, execute this terminal command at site's root directory:

  • bundle exec jekyll serve --incremental --host 0.0.0.0 --port 4000 --open_url

After running the script or executing the command, the website will automatically open local Jekyll server pages in the default browser.

Troubleshooting

• Connection to0.0.0.0:4000 fails:
  • Try localhost:4000 in the browser instead or change --host 0.0.0.0 to --host localhost.
• Some assets on the site are broken:
  • Stop Ruby & Jekyll, remove _site folder, run Jekyll again.
• Jekyll won't launch:
  • Run bundle clean --force in the terminal at lab's root directory, run Jekyll again.

Share the server with local network

Optional! Only needed for testing on mobile devices etc.

1. Open port 4000 (TCP protocol) from router's settings.
2. Find the local IPv4 address of the server PC.
3. Start the server.
4. Navigate to http://[SERVER'S-LOCAL-IPv4-ADDRESS]:4000 on the other device.

Note

Server's local network sharing won't work if --host 0.0.0.0 is changed to --host localhost.

Compressing CSS and JS files in the _includes directory

Installation

Install Minify with your prefered way or based of OS.

On Windows, download binary (minify_windows_amd64.zip) and add that .exe to the folder that's on the PATH (c:\Windows for example, highly recommended to create new PATH variable).

Do the compression

• For Windows, use the 3__compress_includes-dir_css_js.bat script (in the z__bat-scripts dir).

• For Linux (with bash), use the 3__compress_includes-dir_css_js.sh script (in the z__sh-scripts dir).

  • Give permissions first:

    chmod +x 3__compress_includes-dir_css_js.sh

• For other OSes / manual way, go to _includes directory with terminal and paste these commands:

  • minify -o bottom-scripts.min.js         1a____bottom-scripts.js
    minify -o bottom-scripts-module.min.js  1b____bottom-scripts-module.js
    minify -o modules.min.css               2a____modules.css
    minify -o noscript-style.min.css        2b____noscript-style.css
    minify -o fonts.min.css                 2c____fonts.css
    minify -o sanitize.min.css              4a____sanitize.css

While using Jekyll development server, the site uses uncompressed CSS & JS files.

Important

CSS & JS files must be compressed before before opening a pull request!

Credits

• Earhacker from Reddit for converting jQuery code to regular JavaScript (referenced code on the site repo).
• trotzig for "micro-optimising" List.js (#482 PR at List.js repo).

Assets

• iA Writer Duo by iA Inc (SIL OFL 1.1).
• Inter by Rasmus Andersson (SIL OFL 1.1).
• Jekyll Minifier by Aleksandr Meniailo (MIT).
• List.js by Jonny Strömberg (MIT).
• Phosphor Icons by Helena Zhang (MIT).
• sanitize.css by CSS Tools (CC0 1.0 Universal).

License

Custom license, all rights reserved with exceptions mentioned in LICENSE doc.