Website content

This repository containst the contents for the website https://www.magcamit.com. Experimentation/staging content are typically in the experimental branch, and maybe published at https://magcamit.netlify.app/.

Making changes

Quick changes made through the GitHub web interface to the files in the content and static directories on the master branch will be automatically published to the website. For more significant changes, it is recommended to make changes in a separate branch and create a pull request for review before merging to master.

To set up a development environment for the website, follow the instructions below.

1. Clone the Repository: If you haven't already, clone the ODIR repository to your local machine:

   git clone https://github.com/magcamit/magcamit.github.io.git

2. Install necessary tools:

   • just is a handy command runner, which you can install using the instructions.
   • prek is a fast Rust-based alternative to pre-commit, which you can install using the instructions.
   • osv-scanner is a tool for scanning dependencies for vulnerabilities, which you can install using the instructions. Note that this is not really necessary because the website does not have dependencies similar to a software program or a library, but it is a good practice to have it set up for any future additions.

3. Set up pre-commit hooks: To ensure code quality and consistency, we use pre-commit hooks. You can set them up by running:

   just install-pre-commit-hooks

   Note that in the future, there may be better ways to do this, based on the just released version 2.54 of git.

4. Check available just recipes: You can check the available just recipes for various development tasks by running:

   just -l

5. Serve the website locally: To serve the website locally and see your changes in real-time, run:

   just serve

   This will start a local development server, and you can access the website at http://localhost:1111. The server will automatically reload whenever you make changes to the content or static files.

License

• Content: All rights reserved. No part of the articles or personal media on this site may be reproduced without permission.
• Site source: The configuration and layout are proprietary, though based on open-source foundations.

Credits and third-party assets

This site is built using the following open-source components:

• Theme: Based on terminus for Zola.
• Fonts and icons: Included as part of the theme. Additional Font Awesome Free assets, if any, are within the static directory and its sub-directories.