MarkdownDocsExporter

Inherits: JsonIO > Reference > Object
Inherited by: HugoMarkdownDocsExporter

Description

Main markdown exporter. It exports using github flavor markdown. These .md files can be used anywhere, but the links and the _Sidebar.md are configured to work best with github wiki format.

Properties

type property default value
Dictionary links_db Null
Dictionary signatures_db Null
String key_to_use_for_link Null

Methods

return type method signature
Variant build_category_db(String reference_json_path, String export_path)
null export_github_wiki_pages(String reference_json_path, String export_path)

Constants

  • MD_BLOCK_INHERITANCE = " Inherits: {inheritance} “ — Defines the “inheritance” block content model and styling for the exported .md file.
  • MD_BLOCK_INHERITED_BY = " Inherited by: {inherited_by} “ — Defines the “inherited by” block content model and styling for the exported .md file.
  • MD_BLOCK_DESCRIPTION = “## Description {description} “ — Defines the “Description” block content model and styling for the exported .md file.
  • MD_BLOCK_PROPERTIES_TABLE_TITLE = “## Properties | type | property | default value | | —- | ——– | ————- | “ — Defines the “Properties” table header content model and styling for the exported .md file.
  • MD_BLOCK_PROPERTIES_TABLE_LINE = “| {type} | {name} | {default_value} | “ — Defines the property table lines content model and styling for the exported .md file.
  • MD_BLOCK_METHODS_TABLE_TITLE = “## Methods | return type | method signature | | ———– | —————- | “ — Defines the “Methods” table header content model and styling for the exported .md file.
  • MD_BLOCK_METHOD_TABLE_LINE = “| {type} | {siganture} | “ — Defines the method table lines content model and styling for the exported .md file.
  • MD_BLOCK_SIGNALS_TITLE = “## Signals “ — Defines the “Signals” header content model and styling for the exported .md file.
  • MD_BLOCK_SIGNALS_LINE = “- {name}({arguments}) {description} ——— “ — Defines the individial signal content model and styling for the exported .md file.
  • MD_BLOCK_ENUMS_TITLE = “## Enumerations “ — Defines the “Enumerations” header content model and styling for the exported .md file.
  • MD_BLOCK_ENUM_NAME_LINE = “enum {name}: “ — Defines the individial enum name content model and styling for the exported .md file.
  • MD_BLOCK_ENUM_KEY_LINE = “- {signature} “ — Defines the individial enum keys content model and styling for the exported .md file.
  • MD_BLOCK_CONSTANTS_TITLE = “## Constants “ — Defines the “Constants” header content model and styling for the exported .md file.
  • MD_BLOCK_CONSTANTS_LINE = “- {signature} — {description} \n” — Defines the individial constant content model and styling for the exported .md file.
  • MD_BLOCK_PROPERTY = “### {name} - {property_signature} {table} {description} ——— — Defines the individial property definition content model and styling for the exported .md file.
  • MD_BLOCK_PROPERTIES_DESCRIPTION = “## Properties Descriptions “ — Defines the “Properties Descriptions” header content model and styling for the exported .md file.
  • MD_BLOCK_METHOD = “### {name} - {method_signature} {description} ———" — Defines the individial method definition content model and styling for the exported .md file.
  • MD_BLOCK_METHOD_DESCRIPTION = “## Method Descriptions “ — Defines the “Method Descriptions” header content model and styling for the exported .md file.
  • GODOT_DOCS_BASE_URL = “https://docs.godotengine.org/en/stable/classes/class_%s.html" — Godot’s Documentatiion base url for forming links.

Properties Descriptions

Dictionary that serves as database for links and is built during the json export process

signatures_db

Dictionary that serves as database for properties and methods signatures and is built during the json export process

If which key from the links database the exporter should use. Github exporter will use “local_path” which just consists of repeating the file name, without extesnion. Hugo exporter will use “full_path” which will take folder structure into account.

Method Descriptions

build_category_db

Reads json reference and creates a category database with the current user defined categories in use.

export_github_wiki_pages

  • void export_github_wiki_pages(String reference_json_path, String export_path)

Takes in the reference json file path and an export path and generates and exports github wiki formatted .md files.