Skip to content

Commit

Permalink
docs(help): add info about new frontmatter key
Browse files Browse the repository at this point in the history 
for internals links & non shared internal links
  • Loading branch information
@Mara-Li
Mara-Li committed Dec 8, 2022
1 parent b8f9b70 commit 46fb818
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 31 deletions.
34 changes: 18 additions & 16 deletions plugin/i18n/locales/en.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,31 +164,33 @@ export default {
title: "Frontmatter keys cheatsheet",
desc: 'Moreover, there are some frontmatter YAML keys that can be usefull for your workflow. The YAML code below show the default settings, but feel free to change it to your needs in each notes!',
share: "This key is used to share a note with the plugin.",
mdlinks: "convert all wikilinks to markdown links",
mdlinks: "Convert all wikilinks to markdown links",
convert:{
enableOrDisable: "enable or disable the conversion of links. Disabling this will remove the",
enableOrDisable: "Enable or disable the conversion of links. Disabling this will remove the",
or: "or",
syntax: "syntax, while keeping the file name or the alias.",
syntax: "syntax, while keeping the file name or the alternative text.",
},
internals: 'Convert internal links to relative path, if set to false, keep the links as they are.',
nonShared: 'Convert internals links pointing to non shared files to relative path, if set to false, keep the filename or the alternative text.',
embed: {
send: "send embedded note to GitHub",
remove: "remove the embed from the note, leaving empty line.",
send: "Send embedded note to GitHub",
remove: "Remove the embed from the note, leaving empty line.",
},
attachment:{
send: "send all attachments to github",
folder: "change the default folder for the attachments",
send: "Send all attachments to github",
folder: "Change the default folder for the attachments",
},
dataview: "convert dataview queries to markdown.",
hardBreak: "convert all linebreaks to markdown «hard break».",
dataview: "Convert dataview queries to markdown.",
hardBreak: "Convert all linebreaks to markdown «hard break».",
repo: {
desc: "change the default repo for the note.",
owner: "owner of the repo",
repo: "name of the repo",
branch: "branch of the repo",
desc: "Change the default repo for the note.",
owner: "Owner of the repo",
repo: "Name of the repo",
branch: "Branch of the repo",
},
titleKey: "change the title of the note.",
autoclean: "disable or enable autocleaning",
baselink: "change the base link for the copy link command",
titleKey: "Change the title of the note.",
autoclean: "Disable or enable autocleaning",
baselink: "Change the base link for the copy link command",
},
multiRepoHelp: {
title: "Send to multiple repository",
Expand Down
30 changes: 16 additions & 14 deletions plugin/i18n/locales/fr.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,29 +167,31 @@ export default {
share: "Permet de partager une note.",
mdlinks: "Convertit tous les wikilinks en liens markdowns",
convert:{
enableOrDisable: "active ou désactive la conversion des liens. En désactivant cette option, vous supprimez les",
enableOrDisable: "Active ou désactive la conversion des liens. En désactivant cette option, vous supprimez les",
or: "ou",
syntax: "syntaxes, tout en gardant le nom du fichier ou son alias.",
syntax: "syntaxes, tout en gardant le nom du fichier ou son texte alternatif.",
},
internals: 'Convertit les liens internes en chemin d\'accès relatif. Désactivé, les liens seront conservés tels quels.',
nonShared: 'Convertit les liens internes pointant vers des fichiers non partagés en chemin relatif, s\'il est désactivé, garde le nom du fichier ou le texte alternatif.',
embed: {
send: "envoie les notes transclues du fichier partagé dans le dépôt. Seuls les fichiers partagés seront envoyés !",
send: "Envoie les notes transclues du fichier partagé dans le dépôt. Seuls les fichiers partagés seront envoyés !",
remove: "Supprime les notes transclues du fichier partagé, en ne laissant qu'une ligne vide.",
},
attachment:{
send: "envoie toutes les pièces jointes dans le dépôt Git.",
folder: "change le dossier par défaut pour les pièces jointes.",
send: "Envoie toutes les pièces jointes dans le dépôt Git.",
folder: "Change le dossier par défaut pour les pièces jointes.",
},
dataview: "convertit les queries dataview en markdown.",
hardBreak: "convertit tous les sauts de ligne en «hard break» markdown.",
dataview: "Convertit les queries dataview en markdown.",
hardBreak: "Convertit tous les sauts de ligne en «hard break» markdown.",
repo: {
desc: "changer le dépôt GitHub pour cette note.",
owner: "pseudo du propriétaire du dépôt",
repo: "nom du dépôt",
branch: "nom de la branche",
desc: "Changer le dépôt GitHub pour cette note.",
owner: "Pseudo du propriétaire du dépôt",
repo: "Nom du dépôt",
branch: "Nom de la branche",
},
titleKey: "change le titre de la note.",
autoclean: "désactive ou active le nettoyage automatique.",
baselink: "change le lien de base pour la commande de copie de lien.",
titleKey: "Change le titre de la note.",
autoclean: "Désactive ou active le nettoyage automatique.",
baselink: "Change le lien de base pour la commande de copie de lien.",
},
multiRepoHelp: {
title: "Envoie dans plusieurs dépôts",
Expand Down
2 changes: 2 additions & 0 deletions plugin/i18n/locales/ru.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ export default {
or: "or",
syntax: "syntax, while keeping the file name or the alias.",
},
internals: 'Convert internal links to relative path, if set to false, keep the links as they are.',
nonShared: 'Convert internals links pointing to non shared files to relative path, if set to false, keep the filename or the alternative text.',
embed: {
send: "send embedded note to GitHub",
remove: "remove the embed from the note, leaving empty line.",
Expand Down
2 changes: 2 additions & 0 deletions plugin/i18n/locales/zh-cn.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ export default {
or: "or",
syntax: "syntax, while keeping the file name or the alias.",
},
internals: 'Convert internal links to relative path, if set to false, keep the links as they are.',
nonShared: 'Convert internals links pointing to non shared files to relative path, if set to false, keep the filename or the alternative text.',
embed: {
send: "send embedded note to GitHub",
remove: "remove the embed from the note, leaving empty line.",
Expand Down
12 changes: 11 additions & 1 deletion plugin/settings/help.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ export function help(settings: GitHubPublisherSettings) {
});
});
});
l.createEl("li", null, (p) => {
p.createEl("code", {text: 'internals'})
p.createEl("span", {
text: `: ${subSettings("help.frontmatter.internals") as string}`
})
})
l.createEl("li", null, (p) => {
p.createEl("code", { text: "nonShared" });
p.createEl("span", { text: `: ${subSettings("help.frontmatter.nonShared") as string}` });
});
});
span.createEl("li", { text: "embed:", cls: "code code-title" });
span.createEl("ul", null, (l) => {
Expand Down Expand Up @@ -155,7 +165,7 @@ export function help(settings: GitHubPublisherSettings) {
});
});
span.createEl("li", null, (span) => {
span.createEl("code", { text: "baseLink", cls: "code-title" });
span.createEl("code", { text: `baseLink:`, cls: "code-title" });
span.createEl("span", {
text: `: ${subSettings("help.frontmatter.baselink")}`,
});
Expand Down

0 comments on commit 46fb818

Please sign in to comment.