Giter VIP home page Giter VIP logo

epic-guide.github.io's Introduction

EPIC Guide

Guidebook for IC PhD life at EPFL. Visit the guide here!

This guide is put together by EDIC PhD students of all years and from different labs, to help you navigate through your research career at EPFL.

We try to keep the guide up to date, but if you notice any inconsistencies please tell us at [email protected], or make a pull request to this repository. For the guide to grow and stay current over time, we need you to contribute!

How to contribute via pull requests

Where to write

This site is built with Jekyll and GitHub Pages. The main contents are located in one of the _CATEGORY directories, where CATEGORY is one of the following:

  • first (First Year Guide)
  • middle (Middle Years Guide)
  • last (Last Year Guide)
  • life (Life in Lausanne)
  • tools (Research Tools)

If you want to modify some contents of an existing article, locate its corresponding markdown file by observing its permalink: The article with permalink https://epic-guide.github.io/CATEGORY/NAME is located at _CATEGORY/NAME.md.

If you want to write a new article, add a new file in the corresponding directory.

Note: Please avoid changing the names of existing articles as this will change its permalink.

Article header (YML front matter)

In the first few lines of each article, please remember to include/update the following fields:

  • layout: post (Just keep it like this)
  • title: "Candidacy exam" (The full title of the article)
  • category: first (Category as described in the previous section)
  • order: 1 (Order of the article in the category. Articles are sorted in ascending order on the guide index page.)

How to write markdown

The content of the articles can be written in markdown and/or HTML.

Here are some basic markdown syntax if you are not familiar with it. Some examples: https://markdown-it.github.io/

Note: As the h1 heading is reserved for the article title, please use h2 (two hashtags in markdown ##) or smaller headings within the article.

How to make a pull request

To make a pull request, first fork this repository, make changes and commit to your fork, and come back here and click on "compare & pull request".

Remember to add yourself in the contributor list

Edit index.md to include your name!

Testing locally

If you would like to build the webpage locally to preview the changes:

  1. Check (and install if not fulfilled) the prerequisites: Ruby >= 2.5.0 with Dev headers, RubyGems, GCC and Make.
  2. Install Jeykll following the steps according to your operating system.
  3. Change to the root directory of this repo, run first bundle install, and then bundle exec jekyll serve.
  4. Open a browser and go to http://localhost:4000.

epic-guide.github.io's People

Contributors

bayazitdeniz avatar corentindumery avatar grim-bot avatar lee30sonia avatar micha7a avatar shamazo avatar shardulc avatar smishy05 avatar solalpirelli avatar theevann avatar vinitra 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.