Skip to content

Commit

Permalink
docs: autoupdate
Browse files Browse the repository at this point in the history
  • Loading branch information
@MarvinJWendt
MarvinJWendt committed Feb 1, 2025
1 parent 95c838b commit 3f2ef66
Showing 1 changed file with 52 additions and 18 deletions.
70 changes: 52 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
<!--
┌───────────────────────────────────────────────────────────────────┐
│ │
│ IMPORTANT NOTE │
│ │
│ This file is automatically generated │
│ All manual modifications will be overwritten │
│ │
└───────────────────────────────────────────────────────────────────┘
-->

<h1 align="center">AtomicGo | color</h1>

<p align="center">
Expand All @@ -16,7 +33,7 @@
</a>

<a href="https://codecov.io/gh/atomicgo/color">
<!-- unittestcount:start --><img src="https://img.shields.io/badge/Unit_Tests-0-magenta?style=flat-square" alt="Unit test count"><!-- unittestcount:end -->
<!-- unittestcount:start --><img src="https://img.shields.io/badge/Unit_Tests-1-magenta?style=flat-square" alt="Unit test count"><!-- unittestcount:end -->
</a>

<a href="https://opensource.org/licenses/MIT" target="_blank">
Expand Down Expand Up @@ -69,11 +86,7 @@
import "atomicgo.dev/color"
```

Package color is used to generate new AtomicGo repositories.

Write the description of the module here. You can use \*\*markdown\*\*\! This description should clearly explain what the package does.

Example description: https://golang.org/src/encoding/gob/doc.go
Package color is a minimalistic package for coloring terminal output.



Expand Down Expand Up @@ -143,6 +156,7 @@ func main() {
- [func \(c RGBColor\) Sequence\(background bool\) string](<#RGBColor.Sequence>)
- [type Style](<#Style>)
- [func NewStyle\(foregroundColor, backgroundColor Color, modifiers ...Modifier\) Style](<#NewStyle>)
- [func \(s \*Style\) AddModifier\(modifier Modifier\)](<#Style.AddModifier>)
- [func \(s Style\) Fprint\(w io.Writer, a ...any\) \(n int, err error\)](<#Style.Fprint>)
- [func \(s Style\) Fprintf\(w io.Writer, format string, a ...any\) \(n int, err error\)](<#Style.Fprintf>)
- [func \(s Style\) Fprintfln\(w io.Writer, format string, a ...any\) \(n int, err error\)](<#Style.Fprintfln>)
Expand All @@ -154,6 +168,7 @@ func main() {
- [func \(s Style\) Sequence\(\) string](<#Style.Sequence>)
- [func \(s Style\) Sprint\(a ...any\) string](<#Style.Sprint>)
- [func \(s Style\) Sprintf\(format string, a ...any\) string](<#Style.Sprintf>)
- [func \(s Style\) WithModifier\(modifier Modifier\) Style](<#Style.WithModifier>)


## Variables
Expand Down Expand Up @@ -350,13 +365,14 @@ type Modifier int
const (
Reset Modifier = iota
Bold
Faint
Italic
Underline
)
```

<a name="Modifier.Sequence"></a>
### func \(Modifier\) [Sequence](<https://github.com/atomicgo/color/blob/main/modifier.go#L19>)
### func \(Modifier\) [Sequence](<https://github.com/atomicgo/color/blob/main/modifier.go#L20>)

```go
func (m Modifier) Sequence() string
Expand Down Expand Up @@ -416,8 +432,17 @@ func NewStyle(foregroundColor, backgroundColor Color, modifiers ...Modifier) Sty

NewStyle creates a new Style with the given foreground and background colors and modifiers.

<a name="Style.AddModifier"></a>
### func \(\*Style\) [AddModifier](<https://github.com/atomicgo/color/blob/main/style.go#L35>)

```go
func (s *Style) AddModifier(modifier Modifier)
```

AddModifier adds a modifier to the style, if it's not already present.

<a name="Style.Fprint"></a>
### func \(Style\) [Fprint](<https://github.com/atomicgo/color/blob/main/style.go#L70>)
### func \(Style\) [Fprint](<https://github.com/atomicgo/color/blob/main/style.go#L87>)

```go
func (s Style) Fprint(w io.Writer, a ...any) (n int, err error)
Expand All @@ -426,7 +451,7 @@ func (s Style) Fprint(w io.Writer, a ...any) (n int, err error)
Fprint formats using the default formats for its operands and writes to w.

<a name="Style.Fprintf"></a>
### func \(Style\) [Fprintf](<https://github.com/atomicgo/color/blob/main/style.go#L75>)
### func \(Style\) [Fprintf](<https://github.com/atomicgo/color/blob/main/style.go#L92>)

```go
func (s Style) Fprintf(w io.Writer, format string, a ...any) (n int, err error)
Expand All @@ -435,7 +460,7 @@ func (s Style) Fprintf(w io.Writer, format string, a ...any) (n int, err error)
Fprintf formats according to a format specifier and writes to w.

<a name="Style.Fprintfln"></a>
### func \(Style\) [Fprintfln](<https://github.com/atomicgo/color/blob/main/style.go#L85>)
### func \(Style\) [Fprintfln](<https://github.com/atomicgo/color/blob/main/style.go#L102>)

```go
func (s Style) Fprintfln(w io.Writer, format string, a ...any) (n int, err error)
Expand All @@ -444,7 +469,7 @@ func (s Style) Fprintfln(w io.Writer, format string, a ...any) (n int, err error
Fprintfln formats according to a format specifier and writes to w.

<a name="Style.Fprintln"></a>
### func \(Style\) [Fprintln](<https://github.com/atomicgo/color/blob/main/style.go#L80>)
### func \(Style\) [Fprintln](<https://github.com/atomicgo/color/blob/main/style.go#L97>)

```go
func (s Style) Fprintln(w io.Writer, a ...any) (n int, err error)
Expand All @@ -453,7 +478,7 @@ func (s Style) Fprintln(w io.Writer, a ...any) (n int, err error)
Fprintln formats using the default formats for its operands and writes to w.

<a name="Style.Print"></a>
### func \(Style\) [Print](<https://github.com/atomicgo/color/blob/main/style.go#L90>)
### func \(Style\) [Print](<https://github.com/atomicgo/color/blob/main/style.go#L107>)

```go
func (s Style) Print(a ...any)
Expand All @@ -462,7 +487,7 @@ func (s Style) Print(a ...any)
Print formats using the default formats for its operands and writes to standard output.

<a name="Style.Printf"></a>
### func \(Style\) [Printf](<https://github.com/atomicgo/color/blob/main/style.go#L95>)
### func \(Style\) [Printf](<https://github.com/atomicgo/color/blob/main/style.go#L112>)

```go
func (s Style) Printf(format string, a ...any)
Expand All @@ -471,7 +496,7 @@ func (s Style) Printf(format string, a ...any)
Printf formats according to a format specifier and writes to standard output.

<a name="Style.Printfln"></a>
### func \(Style\) [Printfln](<https://github.com/atomicgo/color/blob/main/style.go#L105>)
### func \(Style\) [Printfln](<https://github.com/atomicgo/color/blob/main/style.go#L122>)

```go
func (s Style) Printfln(format string, a ...any)
Expand All @@ -480,7 +505,7 @@ func (s Style) Printfln(format string, a ...any)
Printfln formats according to a format specifier and writes to standard output.

<a name="Style.Println"></a>
### func \(Style\) [Println](<https://github.com/atomicgo/color/blob/main/style.go#L100>)
### func \(Style\) [Println](<https://github.com/atomicgo/color/blob/main/style.go#L117>)

```go
func (s Style) Println(a ...any)
Expand All @@ -489,7 +514,7 @@ func (s Style) Println(a ...any)
Println formats using the default formats for its operands and writes to standard output.

<a name="Style.Sequence"></a>
### func \(Style\) [Sequence](<https://github.com/atomicgo/color/blob/main/style.go#L35>)
### func \(Style\) [Sequence](<https://github.com/atomicgo/color/blob/main/style.go#L52>)

```go
func (s Style) Sequence() string
Expand All @@ -498,7 +523,7 @@ func (s Style) Sequence() string
Sequence returns the ANSI escape sequence for the style.

<a name="Style.Sprint"></a>
### func \(Style\) [Sprint](<https://github.com/atomicgo/color/blob/main/style.go#L54>)
### func \(Style\) [Sprint](<https://github.com/atomicgo/color/blob/main/style.go#L71>)

```go
func (s Style) Sprint(a ...any) string
Expand All @@ -507,14 +532,23 @@ func (s Style) Sprint(a ...any) string
Sprint formats using the default formats for its operands and returns the resulting string.

<a name="Style.Sprintf"></a>
### func \(Style\) [Sprintf](<https://github.com/atomicgo/color/blob/main/style.go#L65>)
### func \(Style\) [Sprintf](<https://github.com/atomicgo/color/blob/main/style.go#L82>)

```go
func (s Style) Sprintf(format string, a ...any) string
```

Sprintf formats according to a format specifier and returns the resulting string.

<a name="Style.WithModifier"></a>
### func \(Style\) [WithModifier](<https://github.com/atomicgo/color/blob/main/style.go#L46>)

```go
func (s Style) WithModifier(modifier Modifier) Style
```

WithModifier returns a new Style with the given modifier added, if it's not already present.

Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)


Expand Down

0 comments on commit 3f2ef66

Please sign in to comment.