mirror of
https://github.com/monero-project/monero-site.git
synced 2024-12-15 21:06:35 +02:00
29 lines
960 B
Markdown
29 lines
960 B
Markdown
### Quick Start
|
|
* Make new .md file in _posts (named whatever, no spaces)
|
|
* Front Matter (below)
|
|
* Write Blog Post
|
|
* Test/Build
|
|
* Submit PR
|
|
|
|
### Make a file
|
|
Navigate to the _posts folder of the website and make a new file. Be sure the file name has no spaces and the ending is .md
|
|
|
|
### Front Matter
|
|
```
|
|
---
|
|
layout: post
|
|
title: CHANGE TO YOUR TITLE
|
|
summary: A BRIEF ONE OR TWO SENTENCE SUMMARY
|
|
tags: [CHOOSE, RELEVANT, TAGS, AND, SEPARATE, THEM, BY, COMMAS, KEEP, THE, BRACKETS]
|
|
author: YOUR NAME OR HANDLE HERE
|
|
---
|
|
```
|
|
|
|
### Write
|
|
After the front matter is finished you are free to write the remainder of your blog post in markdown.
|
|
|
|
### Build/Test
|
|
Build your website using `jekyll serve` if it's not rebuilding automatically and test that your page appears in the 'News' section of the website, as well as the sidebars.
|
|
|
|
### Submit Pull Request
|
|
You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure to make any changes if requested. |