Skip to content

asetalias/blog

Repository files navigation

ALiAS Writes

The official blog of ALiAS Community

Build Status GitHub license GitHub issues GitHub repo size Twitter Follow

This repository holds the source code and related content of the official blog for Amity Linux Assitance Sapience

ALiAS is a platform for upcoming developers for finding exposure by meeting the people working in related industries, learning various languages and becoming better developers.

Please make sure to follow our community Code of Conduct while contributing to the project.

The website has been created using hugo and the theme used is hugo-massively-theme.

Want to help out?

This website is currently under construction and all your inputs are highly appreciated.

  • Any writers willing to add your own thoughts to the blog can refer to the Instruction for Writer section to learn about posting on the blog.

  • Any developers interested in the development of the blog and solving issues can refer to the Instruction for Developers: for help on how to contribute.

  • First time Git/Github users can refer to the First time Contributors section for guides to help start contributing.

  • To be involved in the ongoing discussions please join our Telegram Group.


Website Setup

  1. For hugo installation and usage instructions, refer to Hugo installation and setup.
  2. Clone this repository.
  3. Open Terminal or your preferred CLI and navigate to the location of the repository.
  4. Use the command hugo server to start a local sever of the website on your machine.

The website will be available on http://localhost:1313/


Instruction for Developers:

Git is required to contribute to the website and Hugo is required to run the site and test it on a local server.

  1. For hugo installation and usage instructions, refer to Hugo installation and setup.
  2. Fork the repository and clone to your machine by using the command
$ git clone --recursive https://github.com/<username>/blog.git
  1. To run a local copy of the website, open the command prompt or your preferred CLI, change the directory to the address of the repository and use the command hugo server if you have hugo installed. For instruction on Hugo installation and use, refer to Hugo installation and setup.
  2. Make the changes locally and push them to your own repository.
  3. Review the changes in your repository and submit a pull request.

hugo server starts a local server but hugo builds the website. Be careful when using the commands


Instruction for Writers:

The markup used for blog posts is Markdown.

  1. Fork the repository and clone to your machine by using the command
$ git clone --recursive https://github.com/asetalias/blog.git
  1. Create your work file/blog post in /content/post. See existing files for an example.

    2.5. The format needs to be exactly like the sample post for correct representation.

    Same has been given below. Edit and append this to the top of your post when you are finished writing.

    +++
    title = 'WRITE_A_TITLE_DUH'
    slug = 'give-a-descriptive-slug-like-this-please'
    image = '/images/about.jpg'
    date = "2012-02-06T00:00:00"
    author = 'Creators of ALiAS Writes'
    tags=['this', 'is', 'how', 'tags', 'looks-like']
    categories =['Write', 'better-categries', 'than', 'this']
    description = 'Small oneliners with a tinge of suspense works best'
    disableComments = false
    +++
    
  2. To run a local copy of the website, open the command prompt or your preferred CLI, change the directory to the address of the repository and use the command hugo server if you have hugo installed. For instruction on Hugo installation and use, refer to Hugo installation and setup.

  3. Submit a pull request to submit your work.

Important Notes

  • Use /blog/images/name_of_file for your image source and keep the images in the images folder in static.
  • You can use [img](../img.jpg#center) to center align your images.
  • Make sure the format is correct as per point 2.5
  • Please don't add HD Images, 4K images to blog post. (size>=150KB)
  • All Content should be passed through Grammarly atleast once and spellchecked.

First time contributors/Learn Git:

  1. For a begineers guide on using Github, Visit Hello World-Github.
  2. For a guide to set up git for the first time, visit Setting up Git.
  3. For a begineers git guide, visit git-a simple guide.
  4. For a detailed Git guide, you can read the book pro git.

Help and other Documentation:

  1. For hugo documentation, click here.
  2. For markdown cheat sheet, click here.
  3. For details about the theme, click here.
  4. Getting started with ALiAS: Getting Started