Git Product home page Git Product logo

iitmcvg.github.io's Introduction

Official Site for CVI-IITM

A Github hosted site at link

Theme based on Minimal Mistakes Jekyll Theme: whose documentation may be found here


RoadMap

Date: 12th May 2018.

  1. Jupyter notebook conversion and integration. (jupyter nbconvert)
  2. Google Analytics.
  3. New favicon.
  4. Update projects and documentation.
  5. Add contribution guidelines
  6. Update a Travis CI build status.
  7. MathJax support for equations. >> Moved to cdnjs. See here
  8. Google Insight Optimisation: we currently score a 90.
  9. Setup scripts and Ipynb converter.

Install a local copy

Linux and macOS is supported.

  • Run bash utils/setup.sh.

  • Run bundle exec jekyll serve --drafts --trace.

or

  • Run 'bash utils/run.sh'

In both cases, drafts will be visible. You can use this to preview your local changes.

Send in a pull request to contribute your article.


Convert .ipynb to a Blog post

If you would not like to export your notebook manually, you can choose to use the conversion script. This will convert the notebook into a markdown file with the appropriate templating.

The .ipynb notebook may be referenced from anywhere on your local machine.

To use the same:

usage: convert_nb.py [-h] -nb NOTEBOOK -t TITLE -d DESCRIPTION [-e] [-ty TYPE]
                     [-bp BLOGPATH]

Convert .ipynb notebook into a blog post

optional arguments:
  -h, --help            show this help message and exit
  -nb NOTEBOOK, --notebook NOTEBOOK
                        notebook path
  -t TITLE, --title TITLE
                        Title of article [post|page|any class type]
  -d DESCRIPTION, --description DESCRIPTION
                        Description of article
  -e, --execute         Execute the jupyter notebook before converting
  -ty TYPE, --type TYPE
                        notebook type
  -bp BLOGPATH, --blogpath BLOGPATH
                        Blogsite path

Contributing

We would be happy to accept contributions to articles as our site mature. You can send in a pull request after conforming to these guidelines. ๐Ÿ˜„


Comment Policy (Disqus)

We have largely based our policy on this : The Mary Sue: The Mary Sueโ€™s Comment Policy

We might change this as we proceed.


Form Submissions


MathJax Support

Added by using the use_math tag.

For now defaulted it to every post, page. Will revert in the future in case the pages slow down.

References for the Syntax:

We'll stick to kramdown render (for markdown), since it plays fairly nice with both Jekyll 3.x and MathJax.


Credits

Theme

Michael Rose

Icons + Demo Images:

Other:


License

The MIT License (MIT)

Copyright (c) 2017 CVI-IITM

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

iitmcvg.github.io's People

Contributors

awearytraveler avatar cvigroup avatar dependabot[bot] avatar iev6 avatar kriss21 avatar mukheshpugal avatar nihalgeorge01 avatar obelus0 avatar rishi307 avatar rsnk96 avatar sadidaa avatar varun19299 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  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.