Render results as a Markdown string

Property definitions

nitc :: md_commands $ DocCommand :: to_md
	# Render results as a Markdown string
	fun to_md: Writable do return "**Not yet implemented**"
src/doc/templates/md_commands.nit:28,2--29,56

nitc :: md_commands $ CmdEntity :: to_md
	redef fun to_md do
		var mentity = self.mentity
		if mentity == null then return ""
		return "`{mentity.name}`"
	end
src/doc/templates/md_commands.nit:49,2--53,4

nitc :: md_commands $ CmdCode :: to_md
	redef fun to_md do
		var node = self.node
		if node == null then return ""

		var code = render_code(node)
		var tpl = new Template
		tpl.addn "~~~nit"
		tpl.add code.write_to_string
		tpl.addn "~~~"
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:115,2--125,4

nitc :: md_commands $ CmdGraph :: to_md
	redef fun to_md do
		var output = render
		if output == null then return ""
		return output.write_to_string
	end
src/doc/templates/md_commands.nit:182,2--186,4

nitc :: md_commands $ CmdEntities :: to_md
	redef fun to_md do
		var mentities = self.results
		if mentities == null then return ""

		var tpl = new Template
		for mentity in mentities do
			var mdoc = mentity.mdoc_or_fallback
			tpl.add "* `{mentity}`"
			if mdoc != null then
				tpl.add " - "
				tpl.add mdoc.synopsis
			end
			tpl.add "\n"
		end
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:57,2--72,4

nitc :: md_commands $ CmdComment :: to_md
	redef fun to_md do
		var mentity = self.mentity
		if mentity == null then return ""

		var mdoc = self.mdoc
		var tpl = new Template
		tpl.add "### `{mentity}`"
		if mdoc != null then
			tpl.add " - "
			tpl.add mdoc.synopsis
		end
		tpl.add "\n"
		if mdoc != null then
			tpl.add mdoc.comment
		end
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:76,2--92,4

nitc :: md_commands $ CmdEntityFile :: to_md
	redef fun to_md do
		var file = self.file
		if file == null then return ""
		return "[{file.basename}]({file_url or else ""})"
	end
src/doc/templates/md_commands.nit:265,2--269,4

nitc :: md_commands $ CmdMainCompile :: to_md
	redef fun to_md do
		var command = self.command
		if command == null then return ""

		var tpl = new Template
		tpl.addn "~~~sh"
		tpl.addn command
		tpl.addn "~~~"
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:292,2--301,4

nitc :: md_commands $ CmdIniDescription :: to_md
	redef fun to_md do
		var desc = self.desc
		if desc == null then return ""

		return desc
	end
src/doc/templates/md_commands.nit:192,2--197,4

nitc :: md_commands $ CmdIniGitUrl :: to_md
	redef fun to_md do
		var url = self.url
		if url == null then return ""
		return "[{url}]({url})"
	end
src/doc/templates/md_commands.nit:201,2--205,4

nitc :: md_commands $ CmdIniIssuesUrl :: to_md
	redef fun to_md do
		var url = self.url
		if url == null then return ""
		return "[{url}]({url})"
	end
src/doc/templates/md_commands.nit:222,2--226,4

nitc :: md_commands $ CmdIniMaintainer :: to_md
	redef fun to_md do
		var name = self.maintainer
		if name == null then return ""
		return "**{name}**"
	end
src/doc/templates/md_commands.nit:230,2--234,4

nitc :: md_commands $ CmdIniContributors :: to_md
	redef fun to_md do
		var names = self.contributors
		if names == null or names.is_empty then return ""

		var tpl = new Template
		for name in names do
			tpl.addn "* **{name}**"
		end
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:238,2--247,4

nitc :: md_commands $ CmdIniLicense :: to_md
	redef fun to_md do
		var license = self.license
		if license == null then return ""
		return "[{license}](https://opensource.org/licenses/{license})"
	end
src/doc/templates/md_commands.nit:251,2--255,4

nitc :: md_commands $ CmdEntityFileContent :: to_md
	redef fun to_md do
		var content = self.content
		if content == null then return ""

		var tpl = new Template
		tpl.addn "~~~"
		tpl.add content
		tpl.addn "~~~"
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:273,2--282,4

nitc :: md_commands $ CmdManSynopsis :: to_md
	redef fun to_md do
		var synopsis = self.synopsis
		if synopsis == null then return ""

		var tpl = new Template
		tpl.addn "~~~"
		tpl.addn synopsis
		tpl.addn "~~~"
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:305,2--314,4

nitc :: md_commands $ CmdManOptions :: to_md
	redef fun to_md do
		var options = self.options
		if options == null or options.is_empty then return ""

		var tpl = new Template
		tpl.addn "~~~"
		for opt, desc in options do
			tpl.addn "* {opt}\t\t{desc}"
		end
		tpl.addn "~~~"

		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:318,2--330,4

nitc :: md_commands $ CmdIniCloneCommand :: to_md
	redef fun to_md do
		var command = self.command
		if command == null then return ""

		var tpl = new Template
		tpl.addn "~~~sh"
		tpl.addn command
		tpl.addn "~~~"
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:209,2--218,4

nitc :: md_commands $ CmdFeatures :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:154,2--32

nitc :: md_commands $ CmdNew :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:164,2--32

nitc :: md_commands $ CmdCall :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:168,2--32

nitc :: md_commands $ CmdReturn :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:172,2--32

nitc :: md_commands $ CmdParam :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:176,2--32

nitc :: md_commands $ CmdMains :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:288,2--32

nitc :: md_commands $ CmdTesting :: to_md
	redef fun to_md do
		var command = self.command
		if command == null then return ""

		var tpl = new Template
		tpl.addn "~~~sh"
		tpl.addn command
		tpl.addn "~~~"
		return tpl.write_to_string
	end
src/doc/templates/md_commands.nit:334,2--343,4

nitc :: md_commands $ CmdAncestors :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:138,2--32

nitc :: md_commands $ CmdParents :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:142,2--32

nitc :: md_commands $ CmdChildren :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:146,2--32

nitc :: md_commands $ CmdDescendants :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:150,2--32

nitc :: md_commands $ CmdLinearization :: to_md
	redef fun to_md do return super
src/doc/templates/md_commands.nit:158,2--32