glugnith.github.io's Introduction

Welcome to the Blog of GLUG NITH

This blog uses Pelican Static Site Generator and reStruxturedText. ReStructuredText is a lightweight and powerful markup language very similar to markdown.

Directory Structure

    .
    |_.github       # Workflow Files
    |_content
    |   |_extras    # static files
    |   |_images    # images for posts and website
    |   |_pages     # static pages
    |   |_posts     # post files (add your post here)
    |_themes/alchemy
       |_static     # CSS anf font files
       |_templates  # templates for generating webpages

Contribution Guidelines

Adding a new Post

Fork this repository and clone to your system

    git clone https://github.com/<username>/glugnith.github.io.git

Go to content/posts folder and choose a category to start with. We currently have 4 categories. Feel free to open an issue to recommend new category.

Category	Description
development	web/app/desktop development articles
programming	programming language tips & tricks, competitive programming articles
tools	IDE, editors, other open source development tools articles
experience	interview, internship, placement experience articles

    cd glugnith.github.io/content/posts
    # let us choose development category
    cd development

Add a new reStructuredText file. Check for exisiting file names.

    nano mypost.rst

Your file must contain these components in the following format. Put all images in images directory only.

    *******************************************************
    Your Post Title Surrounded by Asterisks Above and Below
    *******************************************************

    :date: YYYY-MM-DD HH:mm
    :modified: YYYY-MM-DD HH:mm (only if existing article is being modified)
    :tags: add, some, tags, here, seperated, by, commas
    :slug: yourfilename-YYYYMMDD
    :category: category-selected-in-previous-steps
    :author: github-username

    <write your post here>

Save and push to GitHub

    git stage -A
    git commit -m "commit message"
    git push origin master

Improvements

Fork this repository and clone to your system

    git clone https://github.com/<username>/glugnith.github.io.git

This blog is based on Pelican SSG. Install required components.

    cd glugnith.github.io
    sudo pip install -r requirements.txt

Do your changes and test locally (comment SITEURL in pelicanconf.py)

    make html # generate html files
    make serve # serve on local host

Push and add a Pull Request (do not forget to un-comment SITEURL)

References

Pelican
Pelican Documentation
reStructuredText reference - Most of them will work with pelican

glugnith.github.io's People

Contributors

Stargazers

Watchers

glugnith.github.io's Issues

Add a GitHub Action for checking Pull Requests

Provide a Detail Description of your request
Currently, the GitHub Action doesn't check any pull requests. Add a GHA to test the build status of incoming changes via Pull Request.

Hint: Just check what is needed to build this project

Additional context
Add any other context or screenshots about the feature request here.