Skip to content

Commit

Permalink
🚧[docs] Includes module documentation from src
Browse files Browse the repository at this point in the history
Rewrite rules compile the Markdown files into the correct directory structure while leaving them next to the source.
 Is vitepress syntax and has to be sourrounded by a span. ESLint rules are modifed accordingly.
Asset links are cleaned up and somewhat unified. WIP
Dynamic links to Issue #15 and FontAwesome are made static.
  • Loading branch information
N0W0RK committed Mar 26, 2024
1 parent d36ef87 commit c74fb15
Show file tree
Hide file tree
Showing 131 changed files with 1,122 additions and 632 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@
"markdownlint/md033": ["error", {
"allowed_elements": [
"discord",
"a"
"span"
] // These are Vue elements used in the docs
}],
// Bare URL used
Expand Down
19 changes: 18 additions & 1 deletion docsvite/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import fs from 'fs';
import path from 'path';

import { defineConfig } from 'vitepress'
import { createRequire } from 'node:module'

import childProcess from './utils/childProcess';
import config from '../../src/config';
Expand All @@ -13,6 +14,7 @@ import localeConfig, {
} from './utils/localeConfig';

import type { Versions } from './utils/generate/versions';
const require = createRequire(import.meta.url)

const {
DOCS_URL,
Expand Down Expand Up @@ -113,5 +115,20 @@ export default defineConfig({
]
},
locales: localeConfigs.siteConfigs ,
srcDir: 'src'
srcDir: 'src',
rewrites: {
'modules/:module/docs/:lang.md': ':lang/modules/:module.md',
'modules/:module/docs/assets/:lang/:file': ':lang/modules/:file'
},
ignoreDeadLinks: true, //TODO: Remove this line when all links are fixed

// This allows the server renderer to be found. Even inside the modules directory which is outside the workspace
vite: {
resolve: {
alias: {
'vue/server-renderer': require.resolve('vue/server-renderer'),
'vue': require.resolve('vue')
}
}
}
})
274 changes: 274 additions & 0 deletions docsvite/.vitepress/i18n/fr_FR.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,274 @@
{
"404": {
"general": { "home": "Retour à la page d'accueil" },
"modules": {
"content": "Cher utilisateur,\n\nmerci de l'intérêt que vous portez à la page Wiki du module {{module}} ! Malheureusement, nous n'avons pas créer le contenu pour votre langue {{lang}}. Si vous souhaitez contribuer à notre wiki, n'hésitez pas à créer cette page sur {{github}} ! Nous vous suggérons de consulter les fichiers des autres langues pour des exemples dans le {{docs_dir}}.",
"languages": "Ce module a déjà une page Wiki dans les langues suivantes :",
"title": "Aucune page de module n'existe encore"
}
},
"apps": "Apps",
"containers": { "danger": "Danger", "tip": "Tip", "warning": "Attention" },
"contributing": "Contribution",
"description": "Le Wiki pour LSS-Manager V.4",
"footer": {
"contributors": "Contributeurs",
"edit": "Modifier la page",
"lastUpdated": "Dernière mise à jour"
},
"head": {
"alpha": "Ce module n'en est qu'à ses débuts et n'est actuellement disponible que pour les bêta-testeurs !",
"dev": "Ce module est encore en cours de développement. Il est possible qu'il y ait encore quelques bugs !",
"mapkit": "En raison de restrictions de la part de Mapkit, il ne nous est malheureusement pas possible de proposer ce module avec le type de carte `mapkit` pour le moment.",
"settings": "Ce module est paramétrable ! N'hésitez pas à le personnaliser à votre guise."
},
"moment": {
"shorts": {
"l": "Date sans zéros initiaux",
"L": "Date avec des zéros initiaux",
"ll": "Date avec le mois comme mot (forme courte)",
"LL": "Date avec le mois sous forme de mot",
"lll": "Date avec le mois sous forme de mot (forme courte) et heure",
"LLL": "Date avec le mois sous forme de mot et heure",
"llll": "Date complète (forme courte) avec heure",
"LLLL": "Date complète avec heure",
"LT": "Heure",
"LTS": "Heure avec secondes"
},
"titles": {
"shorts": {
"description": "Description",
"example": "Exemple",
"variable": "Variable"
},
"variables": {
"ampm": "AM / PM",
"category": "Categorie",
"description": "Description",
"dom": "Jour du mois",
"dow": "Jour de la semaine",
"doy": "Jour de l'année",
"hour": "Heure",
"minute": "Minute",
"month": "Mois",
"output": "Sortie",
"quarter": "Trimestre",
"second": "Seconde",
"Variable": "Variable",
"week": "Semaine de l'année",
"year": "Année"
}
},
"variables": {
"ampm": { "a": "am / pm", "A": "AM / PM" },
"dom": {
"D": "Jour du mois",
"DD": "Jour du mois (avec des zéros initiaux)",
"Do": "Jour du mois (ordinal)"
},
"dow": {
"d": "Jour de la semaine (Nombre [Dimanche est 0])",
"dd": "Jour de la semaine (Nom, Formes courtes)",
"ddd": "Jour de la semaine (Nom,avec des zéros initiaux)",
"dddd": "Jour de la semaine (Nom)",
"do": "Jour de la semaine (Nombre, ordinal [Dimanche est 0])"
},
"doy": {
"DDD": "Jour de l'année",
"DDDD": "Jour de l'année (avec des 0)",
"DDDo": "Jour de l'année (ordinal)"
},
"hour": {
"h": "Heure (12h)",
"H": "Heure (24h)",
"hh": "Heure (12h, avec des zéros initiaux)",
"HH": "Heure (24h, avec des zéros initiaux)"
},
"minute": {
"m": "Minute",
"mm": "Minute (avec des zéros initiaux)"
},
"month": {
"M": "Mois actuel (Nombre)",
"MM": "Mois actuel (avec des zéros initiaux)",
"MMM": "Mois actuel (Nom, Formes courtes)",
"MMMM": "Mois actuel (Nom)",
"Mo": "Mois actuel (ordinal)"
},
"order": [
"month",
"quarter",
"dom",
"doy",
"dow",
"week",
"year",
"ampm",
"hour",
"minute",
"second"
],
"quarter": {
"Q": "Trimestre actuel",
"Qo": "Trimestre actuel (ordinal)"
},
"second": {
"s": "Seconde",
"ss": "Seconde (avec des zéros initiaux)"
},
"week": {
"w": "Semaine de l'année",
"wo": "Semaine de l'année (ordinal)",
"ww": "Semaine de l'année (avec des zéros initiaux)"
},
"year": { "YY": "Année (2 chiffre)", "YYYY": "Année (4 chiffre)" }
}
},
"pwa": {
"button": "Actualisé",
"message": "Un nouveau contenu est disponible."
},
"readme": {
"serverStatus": {
"game": "Statut du jeu en ligne",
"lssm": "Statut du serveur LSSM"
}
},
"search": "Recherche sur le wiki",
"stats": {
"cloc": {
"blank": "Vide",
"code": "Code",
"comment": "Commentaire",
"files": "fichiers",
"language": "langue",
"percentOfLines": "% de lignes",
"sum": "somme",
"total": "total"
},
"git": {
"changes": {
"deletions": "Lignes comprenant des caractères supprimés",
"files": "fichiers modifiés",
"insertions": "Lignes comprenant des caractères ajoutés",
"title": "Nombre total de modifications sur beta (cumulatif)"
},
"first": "premier commit",
"latest": {
"beta": "Dernier commit de la version bêta",
"stable": "Dernière commit de la version stable"
},
"sum": {
"beta": "commits sur la version bêta",
"stable": "commits sur la version stable"
}
}
},
"tables": {
"browser": "Navigateur",
"download": "Télécharger",
"link": "Lien",
"minVersion": "Version min."
},
"v3": {
"modules": {
"AaoSearch": { "v3Name": "Recherche AAO" },
"aaoZaehler": { "v3Name": "Alarme-Régulation-Compteur d'alarmes" },
"allianceMissionlistShare": { "v3Name": "Part de la mission" },
"centermap": {
"annotation": "Actuellement, seul le mode statique est intégré ici. Le mode dynamique suivra.",
"v3Name": "Plan du centre"
},
"Clock": { "v3Name": "Horloge" },
"creditserweiterung": { "v3Name": "L'expansion du crédit" },
"dashboard": { "v3Name": "Dashboard" },
"DestinationFilter": {
"annotation": "Celui-ci est déjà intégré dans la Refonte pour les véhicules, mais il est également prévu de l'intégrer dans la V4 en tant que module.",
"v3Name": "Demande de transport sur la carte"
},
"displayUserId": { "v3Name": "User-ID" },
"DoctorRadioCall": { "v3Name": "Demande HEMS à la radio" },
"Eventsmission": { "v3Name": "Événements marqués" },
"extendedBuilding": { "v3Name": "Vue agrandie du bâtiment" },
"FMS5InMap": { "v3Name": "Demande de transport sur la carte" },
"fms7Target": {
"annotation": "Disponible dans la V3 uniquement dans la version allemande.",
"v3Name": "fms7Target"
},
"geoBorders": {
"annotation": "Disponible dans la V3 uniquement dans la version allemande.",
"v3Name": "geoBorders"
},
"heatmap": { "v3Name": "LS-Heatmap" },
"iconFilter": { "v3Name": "Filtre de construction d'icônes" },
"keyboardAlert": { "v3Name": "Contrôle de l'affichage des appels" },
"Layout01": {
"annotation": "Nous souhaitons proposer un module pour de nombreuses mises en page, que l'on peut également adapter soi-même.",
"v3Name": "Layout 01"
},
"Layout02": {
"annotation": "Nous souhaitons proposer un module pour de nombreuses mises en page, que l'on peut également adapter soi-même.",
"v3Name": "Layout 02"
},
"Layout03": {
"annotation": "Nous souhaitons proposer un module pour de nombreuses mises en page, que l'on peut également adapter soi-même.",
"v3Name": "Layout 03"
},
"Layout04": {
"annotation": "Nous souhaitons proposer un module pour de nombreuses mises en page, que l'on peut également adapter soi-même.",
"v3Name": "Layout 04"
},
"missionDate": { "v3Name": "Date de la mission" },
"missionHelper": { "v3Name": "Aide à la mission" },
"missionKeyword": { "v3Name": "Mots-clés de la mission" },
"MissionOut": { "v3Name": "MissionOut" },
"Notification_Alert": { "v3Name": "Alerte de notification" },
"overview": { "v3Name": "Survol" },
"Redesign01": { "v3Name": "Redesign 01" },
"releaseNotes": { "v3Name": "Release Notes" },
"RenameFZ": { "v3Name": "Renommer le véhicule" },
"saveVGE": { "v3Name": "Enregistrer les appels d'alliance créés" },
"searchMissions": { "v3Name": "Recherche par mission" },
"ShareAlliancePost": { "v3Name": "Alerter, Partager & Poster" },
"showBackAlarmAbove": {
"v3Name": "Afficher l'alarme de retour ci- dessus"
},
"showChatButtonAbove": {
"v3Name": "Afficher le bouton chat ci-dessus"
},
"showNotTransportButtonAbove": {
"annotation": "Disponible dans la V3 uniquement dans la version allemande.",
"v3Name": "Afficher l'alarme de retour ci-dessus"
},
"statusCount": { "v3Name": "Compteur de statuts" },
"statusDispatching": {
"v3Name": "Demandes de transport améliorée"
},
"sumDailyMissions": {
"v3Name": "Somme des statistiques quotidiennes"
},
"tailoredTabs": {
"annotation": "Disponible dans la V3 uniquement dans la version allemande.",
"v3Name": "tailoredTabs"
},
"verbandsverwaltung": { "v3Name": "Administration" },
"WachenHoverStati": { "v3Name": "État de la station" },
"WachenplanungOnMap": {
"annotation": "Disponible dans la V3 uniquement dans la version allemande.",
"v3Name": "WachenplanungOnMap"
}
},
"tables": {
"annotations": "Remarques",
"changes": "Modifications",
"description": "Description",
"feature": "Fonctionnalité",
"module": "Module",
"setting": "Paramètre"
},
"v4annotations": {
"asyncButtons": "Encore en cours de développement : d'autres fonctionnalités sont à venir.",
"lssmaql": "Une expérimentation qui doit servir à extraire rapidement des données de l'API."
}
}
}
Loading

0 comments on commit c74fb15

Please sign in to comment.