Git Product home page Git Product logo

blog's Introduction

SRA Blog

Repository maintains the SRA Blog. It is accessible here: https://blog.sravjti.in/

Overview

  • Uses Jekyll to generate the static webpage.
  • Uses the theme bitbrain/jekyll-dash
  • Output from Jekyll is pushed to gh-pages branch using github actions. Github Pages is configured to use gh-pages branch.
  • It uses Github Actions to publish the generated jekyll blog to gh-pages, normal github pages jekyll build pipeline can't be used to generate tags, so we manually build using github actions and push to gh-pages branch.
  • It uses the following github action helaili/[email protected]

Submitting new blog posts

  • Fork this repo.
  • All assets like images or videos or gif should go into /assets/posts/, create a new subfolder for the specific post, let's say the blog title is how to use github pages, then create a folder like /assets/posts/how-to-use-github-pages.
  • The content should be written in markdown, the file should go into _posts folder.
  • File should be named as follows, <year>-<month>-<date>-article-name.md.
  • Let's say today's date is 13th June 2021, then the filename is expected to be 2021-06-13-hoe-to-use-github-pages.md
  • Each markdown file must begin with the following predicate
    ---
    layout: post
    title: <name of the article>
    tags: <specific tag with which you want to classify the article, can be something like OpenCV, embedded-system, it shouldn't have spaces>
    description: <put a short description of the topic here>
    ---
    
    -- [Author's name](Link-to-their-github-account)
  • Add your content below, it's good idea to begin with a heading with single #, and go on. For using images follow the following path convention /assets/posts/<name-of-the-post-folder>/<filename>, for example something like this can be done to insert a image ![](/assets/posts/using-jekyll-with-github-pages-part-1/create_repo.png)
  • For reference go through this markdown file: https://raw.githubusercontent.com/SRA-VJTI/blog/master/_posts/2020-09-14-using-jekyll-with-github-pages-1.md
  • Verify that the changes are correct by running it on your local machine, you need bundle and jekyll installed, instructions are here
    # cd into the repository
    gem install jekyll bundler
    bundle exec jekyll serve
    # Visit here http://localhost:4000 to see your changes
  • Commit the changes and file a Pull Request. Please use a proper title, and a short description of the blog post.

License

MIT License

Copyright (c) 2021 Society of Robotics and Automation

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.

blog's People

Contributors

vedantparanjape avatar shankari02 avatar superchamp234 avatar dhruvag2000 avatar nachtspyder04 avatar adityavivekanand avatar aryannanda17 avatar faulty404 avatar kamakshi8104 avatar ossome01 avatar satacker avatar surajsonawane2415 avatar varadnaik921 avatar dhairyashah1 avatar hashmis79 avatar nishatp9 avatar purviyeshi avatar richa-sawant 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.