Skip to content

Commit 3b7372c

Browse files
committed
add readme
1 parent 3bc2c0f commit 3b7372c

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# xdag.io
2+
The website of XDAG, built with [Jekyll](https://jekyllrb.com/docs/home/).
3+
4+
## News Posts guidelines
5+
6+
### Setup
7+
News posts are placed in `_posts/`.
8+
9+
The filename must use the following format:
10+
````
11+
YYYY-MM-DD-title.md
12+
````
13+
14+
Where YYYY is the year (4 digits), MM the month (2 digits), DD the day (2 digits), and .md is the file extension representing the format used in the file. The following are examples of valid post filenames:
15+
16+
````
17+
2018-01-31-Our-fresh-new-website.md
18+
2018-02-03-What-tool-to-use-to-make-poll.md
19+
2018-03-07-XDAG-v0.2.0-is-released.md
20+
````
21+
22+
The file must start with the following YAML code:
23+
````
24+
---
25+
layout: post
26+
title: Title of the post
27+
date: "YYYY-MM-DD hh:mm:ss"
28+
image: "/assets/images/posts/.....jpg/png/gif/..."
29+
---
30+
````
31+
Optional YAML tags:
32+
* `image:` Path to an image file. Displayed on platforms that support Open Graph Markup. Example format for an internal image: `"/assets/images/posts/community-fund-rewards.jpg"`
33+
* `summary:` Summary of the post content. Displayed on search engine results and platforms that support Open Graph Markup. By default, the first line from post content is used.
34+
35+
### Writing
36+
Markdown is used for rich text formatting, you can find examples [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
37+
38+
### Build
39+
Run command `bundle install` to install all dependency.
40+
Run command `bundle exec jekyll serve` you will see the website at http://127.0.0.1:4000/

0 commit comments

Comments
 (0)