Git Product home page Git Product logo

airavata-site's Introduction

Apache Airavata website

This repo contains sources and html for Apache Airavata website.

About this site

The site's content is written in Mark Down which is built with Jekyll to convert to html

The git repo only has one branch asf-site and the source folder has all mark down files. Jekyll will be used to generate the HTML. The generated files are served from 'content' folder.

It is important to understand this distinction:

  1. The source folder has raw markdown files and jekyll code and includes resources for building including the css, javascript and images.
  2. The generated static website content is in the content folder. This is the actual static content hosted but do not edit it directly.

One time Development setup

If you do not have Jekyll, you will need to first install it:

$ gem install jekyll

If you are on a Mac, you may need to install Ruby Gems.

For more instructions refer to the documentation on Jekyll website.

Release updates

Update sources/_data/releases.yml file on releases

Live development

While you are working with the website, you can test and develop live. Run the following command in the source folder of the website:

$ jekyll serve

Jekyll will start a webserver on port 4000. As you make changes to the content, Jekyll will rebuild it automatically. This is helpful if you want to see how your changes will render in realtime.

Generating the static website

Once you are done with your changes, you need to compile the static content for the website. This is what is actually hosted on the Apache Airavata website.

You can build the static content by running the following command in the root website directory:

$ jekyll build

Once built, it will be placed in the folder content inside of the root directory. This directory will include images, HTML, CSS, and so on. In a typical Jekyll install this content would live in _site - it has been changed for the Apache Airavata website to work with the ASF web publishing system.

airavata-site's People

Contributors

afgane avatar ajinkya-dhamnaskar avatar alexxnica avatar anujbhan avatar dimuthuupe avatar eroma2014 avatar gouravshenoy avatar jimmycasey avatar machristie avatar marpierc avatar nipurndoshi avatar rbowen avatar rlenferink avatar sachinkariyattin avatar smarru avatar syodage avatar tilaks26 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

airavata-site's Issues

jekyll config missing?

the README mentions jekyll has been configured to read the sources from source and put the result in content, but this does not seem to happen out-of-the-box for me. Is there a _config.yml missing?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.