Encyclopedia Writing Tutorial

Encyclopedia writing tutorial

> Meta

Welcome to the Encyclopedia Writing Guide. Thank you for respecting these different rules for the writing of the pages. If you have a question that is not addressed on this page, do not hesitate to ask it on the chat!

##Markdown

The encyclopedia is written in Markdown. Here is a syntax guide: https://guides.github.com/features/mastering-markdown/

Titles

The main title of the page must be written with a # in front:

Secondary titles are then written with two sharps, three sharps, etc.

Parent page

To assign a parent to the current page, simply add under the main title:

For example, this page has the Meta page as its parent:

Connections

Links to other pages of the encyclopedia are written between double brackets: [ [ Title ] ] (without the spaces between the brackets).

For example: [ [ Encyclopedia ] ] = Encyclopedia.

If the word is written differently (for example in the plural) it is possible to put an alias in this way: [ [ Title | Text displayed ] ].

Example: link to a weapon: [ [weapons|weapon] ]

It is also possible to include a link to another page of the site between single square brackets: ` Text `.

Example: link to documentation: `documentation`

HTTP contents

Be careful not to include links to HTTP (non-HTTPS) content, as this breaks the security of the page! The browser will show "Unsafe" on all Leek Wars afterwards.

Pictures

To integrate an image, you can host it on the site of your choice (in https), such as imgur or github. Then an Admin will repatriate them to Leek Wars regularly to save them correctly.

All game images can be used directly, with a /image/.png link. They are located here: https://github.com/leek-wars/leek-wars/tree/master/public/image.