Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 2.29 KB
Raw

Contributor Guidelines

This repository follows the usual Github workflow of pull request to make changes to the repository. Once you create a pull request against this repository you will see preview of your changes deployed by Netlify. If you prefer to check changes locally then follow the local development guidelines in this document.

Local Development

Using Hugo

  • Make sure You have installed:

    • GO here and include it in PATH
    • NodeJS here and include it in PATH
    • PostCSS plugin here

  • Install Hugo by following the instructions here.

  • Start a local server from the root of this repository:

    hugo server

Using Docker Compose

  • Install docker-compose by following the instructions here.

  • Start a local server from the root of this repository:

docker-compose up -d

Now go to http://localhost:1313 on your browser. Once you make any changes to the code the changes are compiled in real-time and you can see those in the browser.

Writing a blog

  • Create a folder with the current year under content/en/blog if it does not exists.
  • Create a file of markdown format under this path: content/en/blog/202x named appropriately.
  • At the top of the file create metadata section to look like this:
---
date: 202x-xx-xx
title: Title of the blog
linkTitle: Title for the link
description: >
  First line desc
  second line desc
author: Alpha Beta ([@nan](https://twitter.com/nan))
---
  • Write the blog in general markdown.
  • And create a PR to this repository. You can also view your changes locally before creating a PR using the instructions mentioned in local development section.
  • Read more about organizing blogs here.
  • To see all the different elements supported by the docsy theme for blogs, see this example blog and its associated source code.