diff --git a/content/reference/additional/dist/_index.md b/content/reference/additional/dist/_index.md index 19e9bc6..8db6b9a 100644 --- a/content/reference/additional/dist/_index.md +++ b/content/reference/additional/dist/_index.md @@ -1,6 +1,6 @@ +++ title = "Software Distribution" -weight = 900 +weight = 90 sort_by = "weight" insert_anchor_links = "right" +++ diff --git a/content/reference/additional/docs-app/_index.md b/content/reference/additional/docs-app/_index.md new file mode 100644 index 0000000..1420647 --- /dev/null +++ b/content/reference/additional/docs-app/_index.md @@ -0,0 +1,20 @@ ++++ +title = "Docs App" +weight = 100 ++++ + +### [Overview](/reference/additional/docs-app/overview) + +General information about the Docs apps. + +### [File Format](/reference/additional/docs-app/file-format) + +Information about marks supported by the Docs app. + +### [Index File](/reference/additional/docs-app/index-file) + +Details of the `.toc` index file format. + +### [Suggested Structure](/reference/additional/docs-app/structure) + +Suggestions about how to structure docs. diff --git a/content/reference/additional/docs-app/file-format.md b/content/reference/additional/docs-app/file-format.md new file mode 100644 index 0000000..01f5e3a --- /dev/null +++ b/content/reference/additional/docs-app/file-format.md @@ -0,0 +1,161 @@ ++++ +title = "File Format" +weight = 5 +template = "doc.html" ++++ + +## `%docu` mark + +{% callout %} +**Note**: this section is mostly useful if you're writing a mark conversion +method. For marks that are already supported and you can use directly, see +further down this page. +{% /callout %} + +The `%docs` app supports any mark, as long as it has a conversion method to its +`%docu` mark. The `%docu` mark is not expected to be used directly to write +documentation, its purpose is to be a mark conversion target. + +The `%docu` mark expects a `$manx`. + +A `$manx` is how an XML node structure is represented in hoon. See [Section +5e](/reference/hoon/stdlib/5e#manx) of the standard library reference for +details. A `$manx` is what `++de-xml:html` and `++en-xml:html` decode/encode +raw XML strings from/to. + +The `%docu` mark will technically accept any `$manx`, but the `%docs` agent +itself makes some changes and imposes some additional rules: + +- The root element must be a `
`. +- `

`, `

`, and `

` elements that are direct children of the root + `
` will be used to make the table of contents. Other header levels + will not be included in the table of contents, but they can still be used. + `

`, through `

` can also be used at deeper levels, but they also + won't be included in the table of contents. +- Only these tags are allowed: ``, `
`, ``, `
`, + `
`, ``, ``, `
`, ``, `

`, `

`, `

`, + `

`, `

`, `
`, `
`, ``, ``, ``, `
  • `, `
      `, + `

      `, `

      `, ``, ``, ``, ``, ``, ``,
      +  `