Before starting

If you would like to help beta test AcIo it is available on the download page.

If you are running AcIo on windows you will have to download Git for windows if you have not previously done so. You will also have to setup your login credentials differently from the below instructions for osxkeychain.

If you have not already initialized the repository on github you will need to do that. There are many tutorials on how to do this already avialble such as this one

Tutorial:





Before starting verify that you have a Readme already in your repository. This will be used to build your landing page with AcIO. In future updates you will have the option to not use a readme if you prefer.

  • Open Terminal (or Command Line if using Windows)
  • Change directory to your local repository
cd ~/path/to/your/repository
  • Verify git is installed. If it is not you can follow the instructins from Github directly.
  • Once you have verified that you have git installed and setup the osxkeychain make a new gh-pages branch in your repository.
git checkout -B gh-pages
  • Now we can swtich over to AcIo (but do NOT close the terminal instance)! Right click Acio_gui.app and select open. A pop-up will tell you it is from an unknown source; click open.
  • Fill in your Website title and name
  • Click select directory and find the local repository which you want to make the website from.
  • Select Minimal as the theme (more options will be avialable soon) and select a skin color theme for the minimal-mistakes jekyll theme.
  • Paste your DOI into the box
  • Add photos: Logo will be the upper left portion next to the title of your website. Author Picture of you! Splash image This is the image which will be the main image going across the landing page photo album An album of photos which you want to be displayed from your research!


  • Social Media: Add whatever social media handles you want to be included with the website



Click Acio Website to build the framework of your website!

This could take a bit depending on internet speed but usually will not take longer than 1 minute. Once it completes another window will pop up and say “Framework Created!”

  • Back in your old terminal window commit the changes and push to github.
    git add -A
    git commit -a -m 'AcIo Website frameork created'
    git push
    
  • Go to your github repository on your web browser and now on the right side of the screen you should see “Github-pages” under the environments side view. You can click that and then click “view deployment” on the following page!

Modifying your new website


Future itterations of AcIO will enable the user to make unique pages and edit pre-existing ones. However this can already be done manually if you dig into the theme a bit more. Minimal-Mistakes has many page options and you completely control it through the front matter on the top of the .md files which are generated by AcIO. For more information you can check out the Minimal Mistakes website