FoE Helper
  • Home
  • Deutsch
    • Installation
    • Module
      • Alarm
      • Armeen
      • Blaue Galaxie Helfer
      • Discord Webhooks
      • Eigenanteilsrechner
      • Einstellungen
      • Ereignisse
      • FP-Einsammlungen
      • Freunde in Unterhaltungen
      • Gebäude Effizienzbewertung
      • Gebäude-Kits
      • GEX Ergebnisse
      • Gilden Mitglieder Übersicht
      • Gildengefechte
      • Infobox
      • Investitionen
      • Kampagne
      • Kostenrechner
      • LG Investitionen
      • Markt Filter
      • Moppel assistent
      • Merger Game
      • Notizen
      • Produktionsübersicht
      • Siedlung
      • Späher status
      • Stadtübersicht
      • Statistiken
      • Technologien
      • Verhandlungsassistent
    • Webseite
      • Stadtplaner
    • Mithelfen
      • Github
      • Markdown
      • Dokumentation schreiben
    • Api Token
  • English
    • Installation
    • Modules
      • Alerts
      • Blue Galaxy Helper
      • Building Efficiency Rating
      • Continent Map Overview
      • FP Collector Overview
      • Discord Webhooks
      • FP Investments
      • GB Calculator
      • GB Cost Calculator
      • GB Investment
      • GE Results
      • Guild Battleground (GBG)
      • Guild Member Overview
      • Incidents
      • Info Box
      • Market Filter
      • Merger Game
      • Military Units Overview
      • Motivate/Polish Helper
      • Negotiation Helper
      • Notes
      • Production Overview
      • Scouting Info
      • Sets, Upgrades & Kits
      • Settings
      • Settlements Overview
      • Statistics
      • Technology (Tech) Tree
      • Town Overview
    • Website
      • CityMap
    • Helping out
      • Github
      • Markdown
      • Writing documentation
    • Api Token
  • Français
    • Installation
    • Modules
      • Aide Galaxie Bleue
      • Aide Motivation / Polissage
      • Aide Négociation
      • Alarme
      • Aperçu collecteur PF
      • Aperçu de la production
      • Aperçu de la ville
      • Aperçu des membres de la guilde
      • Aperçu des unités militaires
      • Assistant min-jeu Aztèque
      • Arbre des technologies
      • Calculatrice GM Externe
      • Calculatrice GM Interne
      • Carte de campagne
      • Champ de bataille de guilde
      • Colonie culturelle
      • Comparer les amis
      • Discord Webhooks
      • Efficience des bâtiments
      • Filtre du marché
      • GcG
      • Incidents
      • Infos de l'éclaireur
      • Infos Système
      • Investissement GM
      • Investissement PF
      • Notes
      • Pack et Améliorations
      • Paramètres
      • Recherche GM
      • Résultat de l'EG
      • Statistiques
      • Système de chateau
    • Site Web
      • Planificateur de cité
    • Jeton API
    • Aide
      • Github
      • Markdown
      • Ecrire un doc
  • Italian
    • Installazione
    • Sito
      • Mappa della città
    • Aiuto
      • Github
      • Markdown
      • Scrittura della documentazione
Powered by GitBook
On this page
  • Create the file
  • Structure
  1. English
  2. Helping out

Writing documentation

Structure of a docu and its code

Create the file

Create a new empty README.md file in a folder named after a module of the helper. As an example, you can look at the directory /de/erweiterung/kostenrechner. There is also a hidden picture folder. Screenshots of the cost calculator will be placed there.

A README.md will not appear in the URL, it will be treated as an index.*. If it is necessary to divide a module into several pages, use unique lower case names without special characters or spaces.

This file/path must then be added to the /SUMMARY.md in the root directory.

* [Helping out](english/guide/README.md)
  * [Github](english/guide/github.md)
  * [Markdown](english/guide/markdown.md)
  * [Write a docu](english/guide/documentation.md)

Gitbook then renders the correct structure from this and automatically generates the links.

Structure

The subtitle of the page itself always appears at the top. Here is the title of this page

---
description: Structure of a docu and its code
---

Only then comes the first headline:

# Documentation

From here on, you can simply write.

PreviousMarkdownNextApi Token

Last updated 2 years ago