Skip to content

serverx-org/SERVER-X-101

Repository files navigation

SERVER-X-101

SERVER X 101

To work on this repository install Hugo

In Windows:

Chocolatey
Chocolatey is a free and open-source package manager for Windows. To install the extended edition of Hugo:

choco install hugo-extended

Scoop
Scoop is a free and open-source package manager for Windows. To install the extended edition of Hugo:

scoop install hugo-extended

Winget
Winget is Microsoft’s official free and open-source package manager for Windows. To install the extended edition of Hugo:

winget install Hugo.Hugo.Extended

In Linux:
To install the extended edition of Hugo:

sudo snap install hugo

To enable or revoke access to removable media:

sudo snap connect hugo:removable-media
sudo snap disconnect hugo:removable-media

To enable or revoke access to SSH keys:

sudo snap connect hugo:ssh-keys
sudo snap disconnect hugo:ssh-keys

In macOS:

Homebrew
Homebrew is a free and open-source package manager for macOS and Linux. To install the extended edition of Hugo:

brew install hugo

MacPorts
MacPorts is a free and open-source package manager for macOS. To install the extended edition of Hugo:

sudo port install hugo

Website Development Instructions

To contribute to the development of our website, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/SERVER-X-101/SERVER-X-101.git
    
  2. Install Dependencies:

    npm i
    
  3. Start Localhost Server:

    npm start
    
  4. Make Changes: Once the server is running, make your desired changes to the codebase.

  5. Create a Pull Request: After making changes, create a pull request (PR) to merge your code into the main branch.

  6. Resolve Issues: Ensure that your PR addresses and resolves any related issues by mentioning them in the PR description.

Thank you for contributing to our project!

Instructions for Content Contributors::

For Articles:

  • Navigate to the content directory.
  • Then to the articles directory.
  • Create a folder using snake_case with your article title, e.g., article_name.
  • Add an img folder for images related to your article inside the created directory.
  • Add a featured.png file for the card image of your article.
  • Create an _index.md_ file and add your article in Markdown format.
  • Inside _index.md, use the following template format:

Articles template:

---
title: Article Title
description: Small Description for Your Article
author: Author Name
lastmod: 2024-03-18T00:00:00-00:00 (example)
github: link (if any GitHub link is available; otherwise, do not add)
tags:
  - tag1
  - tag2

---

From here, you can write your article...

For Contests:

  • Navigate to the content directory.
  • Then to the contests directory.
  • Create a folder using snake_case with your contest title, e.g., contest_name.
  • Add an img folder for images related to your contest inside the created directory.
  • Add a featured.png file for the card image of your contest.
  • Create an _index.md_ file and add your contest in Markdown format.
  • Add information about the contest, a small description, or any images if available.
  • Create problem_1.md and add the first problem name of the contest inside the contest_name directory that you created.
  • Similarly, create content for other problems.
  • Inside each problem's Markdown file, use the following template format:

Contests template:

---
title: Contest Title
description: Small Description for Your Contest
author: Author Name
lastmod: 2024-03-18T00:00:00-00:00 (example)
practice: true | false (for contests which come under practice)
vignan-challenges: true | false (for contests which come under vignan challenges)
tags:
  - tag1
  - tag2

---

From here, you can write your article...

If you want to contribute to the website layout:

  • You can refer to the HUGO documentation for more information.
  • You can use the layout directory for the layout of the website.

Thank you for your contribution!