Skip to content

Commit 898cc7e

Browse files
committed
Added information about author meta data
1 parent 0588cb4 commit 898cc7e

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,23 @@ Writing a new text-only article can be very simple using just GitHub:
1818
- `article-name` is dash-separated, lower-cased article title using just ASCII letters/numbers (in other words, no diacritics, please)
1919

2020
Full example: `2006-08-09_jak-jsem-v-lese-potkal-medveda.md`
21-
3. Start your article file with following header:
21+
3. Start your article file with header similar to following:
2222

2323
```
2424
Title: Jak jsem v lese potkal medvěda
2525
Date: 2006-08-09 10:49:00
26+
Author: Pepa Houbař
27+
Twitter: @houbyfaktzeru
28+
Gravatar: pepa.houbar@example.com
29+
About: Pepa je vášnivý houbař. Má stránky [Houby fakt žeru](http://example.com) a chodí do lesa především kolem Houbové Lhoty. Jeho životním mottem je _vím houby, jím houby_.
2630
2731
...
2832
```
2933
30-
The time isn't very important.
34+
- The time (`10:49:00`) isn't very important.
35+
- You don't have to add `Twitter:` if you don't use [Twitter](http://twitter.com/).
36+
- [Gravatar](http://gravatar.com/) is a way how to get your photo from your e-mail address. You need to register at the Gravatar site and upload your image there for your e-mail before it starts to work. Of course, you don't have to use it.
37+
- `About:` is couple of sentences about you. You can use [Markdown format](https://guides.github.com/features/mastering-markdown/) as formatting.
3138
4. Then, in place of the three dots `...` you can start writing your article in the [Markdown format](https://guides.github.com/features/mastering-markdown/). You can see how the article will approximately look like using the <kbd>Preview</kbd> tab. Setting <kbd>Soft wrap</kbd> in the top right corner is also handy.
3239
5. When done with writing, fill the form at the bottom of the page (describe your addition, i.e. "Přidávám článek o medvědovi") and press the <kbd>Propose new file</kbd> button.
3340

0 commit comments

Comments
 (0)