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

Fix deployment, fix documentation generation, add a small markdown generator

Browse source
This commit is contained in:
Pieter Vander Vennet 2021-06-15 00:28:59 +02:00
parent e480c97676
commit 8e72b70742
27 changed files with 478 additions and 399 deletions
Download patch file Download diff file Expand all files Collapse all files

50
scripts/generateDocs.ts
View file

@ -1,25 +1,53 @@
import {Utils} from "../Utils";
Utils.runningFromConsole = true;
import SpecialVisualizations from "../UI/SpecialVisualizations";
import {writeFileSync} from "fs";
import {UIElement} from "../UI/UIElement";
import SimpleMetaTagger from "../Logic/SimpleMetaTagger";
import Combine from "../UI/Base/Combine";
import {ExtraFunction} from "../Logic/ExtraFunction";
import ValidatedTextField from "../UI/Input/ValidatedTextField";
import BaseUIElement from "../UI/BaseUIElement";
import Translations from "../UI/i18n/Translations";
import {writeFileSync} from "fs";
import LayoutConfig from "../Customizations/JSON/LayoutConfig";
import State from "../State";
import {QueryParameters} from "../Logic/Web/QueryParameters";
const TurndownService = require('turndown')
function WriteFile(filename, html: UIElement) : void {
const md = new TurndownService().turndown(html.InnerRenderAsString());
writeFileSync(filename, md);
function WriteFile(filename, html: string | BaseUIElement): void {
writeFileSync(filename, Translations.W(html).AsMarkdown());
}
WriteFile("./Docs/SpecialRenderings.md", SpecialVisualizations.HelpMessage)
WriteFile("./Docs/CalculatedTags.md", new Combine([SimpleMetaTagger.HelpText(), ExtraFunction.HelpText()]))
writeFileSync("./Docs/SpecialInputElements.md", ValidatedTextField.HelpText());
WriteFile("./Docs/CalculatedTags.md", new Combine([SimpleMetaTagger.HelpText(), ExtraFunction.HelpText()]).SetClass("flex-col"))
WriteFile("./Docs/SpecialInputElements.md", ValidatedTextField.HelpText());
new State(new LayoutConfig({
language: ["en"],
id: "<theme>",
maintainer: "pietervdvn",
version: "0",
title: "<theme>",
description: "A theme to generate docs with",
startLat: 0,
startLon: 0,
startZoom: 0,
icon: undefined,
layers: [
{
name: "<layer>",
id: "<layer>",
source: {
osmTags: "id~*"
}
}
]
}))
QueryParameters.GetQueryParameter("layer-<layer-id>", "true", "Wether or not the layer with id <layer-id> is shown")
WriteFile("./Docs/URL_Parameters.md", QueryParameters.GenerateQueryParameterDocs())
console.log("Generated docs")