Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 1.64 KB
Raw

Contributing to the website

This website uses Hugo as a static site generator and is hosted on GitHub Pages. To contribute to the website, you will need to install and configure:

  1. Git
  2. Go
  3. Hugo

Fork this repository and clone your fork onto your local machine to make modifications.

Test the site and your modifications locally by running:

➜  ~ hugo server -D

The -D option will show you pages still in draft mode.

Writing a blog for the TLA+ website

If you would like to write a blog for the TLA+ website, follow these steps:

  1. Create a new markdown file using the blog archetype by running:
➜  ~ hugo new --kind blog blog/<blog title>/_index.md

This _index.md file will be prepopulated with the following markdown frontmatter:

+++
type = "blog"
menuPre = " "
title = 'blog title'
linkTitle = ''
description = ""
date = <date that you ran the hugo new command>
draft = true
+++

  1. Change the information in the title, linkTitle, and description to fit your content.

  2. Below the last +++, write your content normally in markdown.

  3. Preview your blog entry anytime by running:

➜  ~ hugo server -D
  1. Once you are happy with your blog entry, take it out of draft mode by changing the flag in the frontmatter:
draft = false
  1. Contribute your blog post upstream to this repository using the normal pull request mechanism.

While this website does not make use of all features available in the Hugo Relearn theme, you can read its documentation to learn more.