Skip to content

avniproject/avni-website

Repository files navigation

Netlify Status

See live - https://avniproject.org/

Development - Getting Started

Install gatsby-cli globally - npm install -g gatsby-cli

In repo root:

  • Install dependencies - npm install or make deps
  • Start development server - gatsby develop or make start
  • Check the website at http://localhost:8000

How to write a blog?

Writing a blog is a common activity that is not developer related. Here is a detailed version of how to add a blog to the Avni website for non-developers. For details such as git knowledge, it points out to a bunch of locations, and for the writing part, this section shows you the right places to make changes.

Set up your machine

You will first need to be able to run the blog locally, or you won't have any guarantee of it working for real. It will also help in verifying if your formatting really worked fine, if your image really shows up etc. In order to do that

  • Clone the repository to your laptop
  • Install npm
  • Follow the Getting Started section above to set up the blog on your machine

Creating the blog

  • Your blog should be in the src/blog directory with a file name <YYYY-MM-DD-title>.md.
  • Any images you add should be in the static/img/ directory. Add a directory with the same name as the blog and add your images there.
  • To understand how to link your image with your blog, look at other blogs
  • All your content will be in markdown format. Markdown is easy, try out a few samples from here or just look back at our previous blogs

Publishing the blog

  • Once you are happy with the way the blog turned up in your local server, push the commit to Github or raise a pull request. You will need some familiarity to Git and Github to do this. Checkout documentation from Github and learn a few tricks from there.