midgard/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Documentation updates

Browse source
This commit is contained in:
Pieter Vander Vennet 2021-11-08 02:36:01 +01:00
parent 78c689b7e8
commit 09eee08fbc
32 changed files with 600 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

6
scripts/generateDocs.ts
View file

@ -11,13 +11,15 @@ import {QueryParameters} from "../Logic/Web/QueryParameters";
import LayoutConfig from "../Models/ThemeConfig/LayoutConfig";
import Minimap from "../UI/Base/Minimap";
import FeatureSwitchState from "../Logic/State/FeatureSwitchState";
import AllKnownLayers from "../Customizations/AllKnownLayers";
import {AllKnownLayouts} from "../Customizations/AllKnownLayouts";
Utils.runningFromConsole = true;
function WriteFile(filename, html: string | BaseUIElement, autogenSource: string[]): void {
writeFileSync(filename, new Combine([Translations.W(html),
"Generated from " + autogenSource.join(", ")
"\n\nThis document is autogenerated from " + autogenSource.join(", ")
]).AsMarkdown());
}
@ -25,7 +27,7 @@ WriteFile("./Docs/SpecialRenderings.md", SpecialVisualizations.HelpMessage(), ["
WriteFile("./Docs/CalculatedTags.md", new Combine([SimpleMetaTagger.HelpText(), ExtraFunction.HelpText()]).SetClass("flex-col"),
["SimpleMetaTagger", "ExtraFunction"])
WriteFile("./Docs/SpecialInputElements.md", ValidatedTextField.HelpText(), ["ValidatedTextField.ts"]);
WriteFile("./Docs/BuiltinLayers.md", AllKnownLayouts.GenLayerOverviewText(), ["AllKnownLayers.ts"])
Minimap.createMiniMap = _ => {
console.log("Not creating a minimap, it is disabled");
return undefined