Skip to content
This repository has been archived by the owner on Sep 11, 2023. It is now read-only.

aivillage/village_website

Repository files navigation

AI Village website

https://aivillage.org/

Blog

If you want to contribute a blog post just email [email protected]! We can help you edit it and tailor it to our audience. If you've just started writing or have an idea, email us and we'll do our best to help you get your content out there. We'll take techical posts and non-technical ones. We'll also take cross posted blogs and you can put your social media links at the top of the post.

The final stage is just a zip with a markdown file, and a folder for the images, javascript, and pages you’d like to include. For an example, this post is generated by this markdown with this content folder. We support Mathjax, and you can see examples of that in the included markdown in the zip. Currently javascript things like slideshows are done in iframes, we can help you get these working. If you have any questions or want to do something weird (like the toys here), just ask and we can figure something out.

Info

This is a static website is generated with Hugo using the Coder theme. You will need hugo 0.40 or greater, which ubuntu 16.04 does not install by default. However, homebrew and later versions of ubuntu are fine. You will also need lesscss and uglifycss through node.

Build & Deploy

The source code for the site is hosted on the "code" branch and static assets are served from the "master" branch.

To make use of the deploy.sh script, your build environment should be organized as such:

root
|-- www (CURRENT DIRECTORY) -> tracking code branch of aivillage/www.git
|    +-- archetypes 
|    +-- content
|    +-- data
|    +-- ...
|    --- README.md
|    --- deploy.sh
|    --- ...
|-- site-assets -> tracking master branch of aivillage/www.git
|   +-- about
|   +-- categories
|   +-- css
|   +-- ...

To test that all the files are in the correct location and everything points correctly you can use deploy_local.sh. This will do all the steps in the normal deploy script, but not upload the result to github.

For the local deployment, the links are all absolute and will point to the actual website, so static assets and links on your local site will not work. However it is useful for formating content.

Contributors

Main developer of the site is @cchio. Please contact him for any escalations or questions.