GithubHelp home page GithubHelp logo

meelgroup-website's Introduction

Instruction to install dependencies

Prerequisites:

  1. Clone the repo:

    `git clone https://github.com/meelgroup/meelgroup-website`
    
  2. Initialize the theme:

    cd meelgroup-website
    git submodule update --init --recursive
    
  3. View your new website on localhost:

    hugo server
    

    Now you can go to localhost:1313.

  4. To deploy, run:

    chmod +x deploy.sh
    ./deploy.sh 
    

Instruction for adding Papers

  • To add a new paper(<name_of_paper>). Add <name_of_paper.md> like other md files and for adding bib information add <name_of_paper.bib> in static/files/citations/.

Instruction for adding Widgets

  • To create widgets and their md file in content/home(For eg. see people.md that adds people widget.)
  • You'll also need to change config.toml to make any global configuration changes.

Instruction for adding your photos

  • See content/home/people.md.

  • Add your name (if you happen to have a homepage you can link your name to that url) under appropriate group and jpg/png image in /static/img/ directory. After that add html(see existing entries) with src changed to your image location.

NOTE:

  • The md files also take plain html. So if you want, you can hack html to make small changes.

  • Also when you run deploy.sh, the website rebuilds from the repo, So you may want to confirm your changes before running the script. Hence it's recommended that after making the changes you first run it on localhost using hugo server

  • In case you have pushed the wrong code, you can do a git reset HEAD~1 , push back again and rerun the script to reach back to the initial state.

  • If you're having trouble installing hugo and intend to make small changes only, you can also do the following:

     ```
     # Fork the repo https://github.com/meelgroup/meelgroup-website 
     git clone https://github.com/<your_name>/<your_website_name>
     cd <your_website_name>
     git checkout -b <new_branch>
     # Make whatever changes,  git add and commit
     # Now go to github and initiate a Pull-Request 
     # Now the Maintainer would accept the PR and merge it with the master 
     ```
    

For more documentation see this.

License

Copyright 2017 George Cushen.

Released under the MIT license.

Analytics

meelgroup-website's People

Contributors

idealrealism avatar gcushen avatar rahulguptakota avatar bishwamittra avatar

Watchers

James Cloos avatar

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.