https://github.com/shiv-source/markdowntable
A Go package to generate Markdown table
https://github.com/shiv-source/markdowntable
golang markdown-table markdowntable package
Last synced: 10 months ago
JSON representation
A Go package to generate Markdown table
- Host: GitHub
- URL: https://github.com/shiv-source/markdowntable
- Owner: shiv-source
- License: mit
- Created: 2025-01-18T01:47:48.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-18T02:15:44.000Z (over 1 year ago)
- Last Synced: 2025-03-18T09:47:57.737Z (about 1 year ago)
- Topics: golang, markdown-table, markdowntable, package
- Language: Go
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# markdownTable
A Go package to generate Markdown tables from header and body data. This package automatically adjusts column widths based on the longest entry in each column, ensuring that the table is aligned and visually clear when rendered in Markdown.
## Features
- Converts a given header and body data into a well-formatted Markdown table.
- Automatically adjusts column widths based on the longest entry (including headers).
- Truncates rows with fewer columns than the header to maintain consistency.
- Provides a clean and simple way to create Markdown tables programmatically in Go.
## Installation
To install the `markdownTable` package, use the following Go command:
```bash
go get github.com/shiv-source/markdownTable
```
## Example Usage
Here’s an example of how to use the `CreateMarkdownTable` function:
```go
package main
import (
"fmt"
"github.com/shiv-source/markdownTable"
)
func main() {
head := []string{"ID", "Name", "Age"}
body := [][]string{
{"1", "John", "26"},
{"2", "Bob", "25"},
{"3", "Alice", "27"},
}
// Create the Markdown table
markdownTable := markdownTable.CreateMarkdownTable(head, body)
// Print the Markdown table
fmt.Println(markdownTable)
}
```
### Expected Output:
```markdown
| ID | Name | Age |
|-----|--------------|-----|
| 1 | John | 26 |
| 2 | Bob | 25 |
| 3 | Alice | 27 |
```
## Function Signature
```go
func CreateMarkdownTable(head []string, body [][]string) string
```
### Parameters:
- `head`: A slice of strings representing the column headers of the table.
- `body`: A slice of slices, where each inner slice represents a row of data in the table.
### Returns:
- A string containing the Markdown-formatted table.
## Contributing
If you would like to contribute to this project, feel free to fork the repository, make changes, and create a pull request. All contributions are welcome!
### Steps to contribute:
1. Fork the repository.
2. Create a feature branch (`git checkout -b feature-name`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature-name`).
5. Create a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.