https://github.com/cdhunt/format-document

Helper for formatting web documents in Markdown, Html, or Confluence.
https://github.com/cdhunt/format-document

confluence devops-toolkit documentation-tool html markdown powershell powershell-module

Last synced: 26 days ago
JSON representation

Helper for formatting web documents in Markdown, Html, or Confluence.

• Host: GitHub
• URL: https://github.com/cdhunt/format-document
• Owner: cdhunt
• License: apache-2.0
• Created: 2023-12-19T18:31:39.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-02T13:34:31.000Z (11 months ago)
• Last Synced: 2024-02-03T14:45:13.553Z (11 months ago)
• Topics: confluence, devops-toolkit, documentation-tool, html, markdown, powershell, powershell-module
• Language: PowerShell
• Homepage:
• Size: 85 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Format-Document

This module contains an HTML-like DSL for dynamically constructing documents using PowerShell.

The same template can be rendered to any one of the following formats which render as similarly as possible.

Formats supported:

- Markdown ([GitHub-flavored](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax))

- [Confluence Storage Format](https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html)

- Html (with [Bootstrap](https://getbootstrap.com/) class decorations)

You can use this to automatically maintain and synchronize documentation in multiple formats such as READMEs and Confluence Wiki.

## CI Status

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/cdhunt/Format-Document/powershell.yml?style=flat&logo=github)

[![Testspace pass ratio](https://img.shields.io/testspace/pass-ratio/cdhunt/cdhunt%3AFormat-Document/main)](https://cdhunt.testspace.com/projects/67973/spaces)

[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/Format-Document.svg?color=%235391FE&label=PowerShellGallery&logo=powershell&style=flat)](https://www.powershellgallery.com/packages/Format-Document)

![Build history](https://buildstats.info/github/chart/cdhunt/Format-Document?branch=main)

## Install

[powershellgallery.com/packages/Format-Document](https://www.powershellgallery.com/packages/Format-Document)

`Install-Module -Name Format-Document` or `Install-PSResource -Name Format-Document`

![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/httpunitps?color=%235391FE&style=flat)

## Docs

[Full Docs](docs)

### Examples

Generate a document in Markdown.

Each element accepts either a ScriptBlock or a String.

Use a ScriptBlock if you want more powerful text generation.

Unenclosed text will be passed through as is.

```powershell

New-Document -Type Markdown {

    H1 "My Text"

    H2 { "Heading 2" }

    P { Get-Date }

    P {

        "normal text"

        B "bold text cmdlet"

        "."

        Link "link Text" "https://google.com"

    }

    Table {

        TR {

            TH "Heading 1","Heading 2"

        }

        TR {

            TD -Text "Fun"

            TD -Text "Moar Fun"

        }

        TR {

            TD "Item 1","Item 2"

        }

    }

}

```

![markdown example](docs/image/markdown.png)

---

Using the same template and changing `-Type` parameter to `Confluence` renders the document in [Confluence Storage Format](https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html).

![confluence example](docs/image/confluence.png)

You can use [ConfluencePS](https://www.powershellgallery.com/packages/ConfluencePS) to publish the content.

```powershell

$page = Get-ConfluencePage -PageID 123456789

$doc = New-Document -Type Confluence { ... }

$page.Body = $doc

$page | Set-ConfluencePage

```