mdoc-export-html(1)

✨ mdoc-export-html ✨

okay bestie so this is a page from the General Commands Manual, and it's literally the whole tea on mdoc export-html — a little tool that takes your mdoc(5) XML docs and turns them into HTML. no cap, it's giving documentation-glow-up energy 💅

🌸 NAME 🌸

mdoc export-html — convert mdoc(5) XML to HTML. that's it, that's the whole job, and it does it gorgeously 💖

🦋 SYNOPSIS 🦋

mdoc export-html [OPTION]* DIRECTORIES

✨ DESCRIPTION ✨

mdoc export-html creates HTML files from the mdoc(5)-formatted documentation XML files that live inside DIRECTORIES. you point it at your docs, it hands you back HTML. iconic behavior fr fr 👑

💅 OPTIONS 💅

• --default-template — writes the default XSLT straight to stdout. like, it just yeets the template at you 🌈
• --ext=EXTENSION — the file extension to use for the created files. this defaults to html.
• --force-update — always generate new files, no questions asked. if you don't pass this, it only generates a new output file when the source documentation file is newer than the target output file. so it's lowkey doing a vibe check on timestamps 🕐
• -o, --out=DIRECTORY — write the created files inside the directory DIRECTORY.
• --template=FILE — an XSLT file to use to generate the created files. if you don't specify one, it uses the template produced by --dump-template. see the TEMPLATE FORMAT section below for more deets 👇
• --with-profile=PROFILE — only process types and members within the .NET profile PROFILE. you can specify this multiple times, bestie. if you don't specify it at all, every type and member gets processed regardless of version.

the valid profiles are:

• monotouch
• net_1_0
• net_1_1
• net_2_0
• net_3_0
• net_3_5
• net_4_0
• silverlight

• --with-version=VERSION — only process types and members within the assembly version VERSION. may also be specified multiple times. if you don't specify it, all types and members are processed regardless of version.

VERSION is an assembly version, e.g. 2.0.5.0.

• -h, -?, --help — display a help message and exit. your girl is always here to help 🫶

🎀 TEMPLATE FORMAT 🎀

the template file is an XSLT, and it needs to process this input XML document:

<Page>
  <CollectionTitle>Collection Title</CollectionTitle>
  <PageTitle>Page Title</PageTitle>
  <Summary>Page Summary</Summary>
  <Signature>Type Declaration</Signature>
  <Remarks>Type Remarks</Remarks>
  <Members>Type Members</Members>
  <Copyright>Documentation Copyright</Copyright>
</Page>

the generated HTML also makes use of several CSS classes. you've got two options, bestie: either use the create-default-style named template found within the --default-template output to generate these classes, or explicitly define the following CSS classes yourself:

• .CollectionTitle
• .PageTitle
• .Summary
• .Signature
• .Remarks
• .Members
• .Copyright
• .Section
• .SectionBox
• .NamespaceName
• .NamespaceSummary
• .MemberName
• .MemberSignature
• .MemberBox
• .Subsection
• .SubsectionBox
• .SignatureTable
• .EnumerationsTable
• .CodeExampleTable
• .MembersListing
• .TypesListing
• .InnerSignatureTable
• .TypePermissionsTable

🔗 HTML LINKS 🔗

all members within the HTML file have an id attribute so you can link straight to a specific member. the value of that id attribute is the String ID of the specified member. deep-linking slay 💖

see the CREF FORMAT section of mdoc(5) for more info.

📬 MAILING LISTS 📬

visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details. come hang out, the group chat is open 🌸

🌐 WEB SITE 🌐

visit http://www.mono-project.com/docs/tools+libraries/tools/mdoc/ for details

not me ending the page like every good manpage does — from the General Commands Manual, dated mdoc-export-html(1), no notes 💅✨

okay that's the whole thing bestie, go forth and export some HTML 🦋💜🎀