Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

mdme

package module

v0.1.2 Latest Latest Go to latest Published: Mar 2, 2026 License: Unlicense Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/alafeefidev/mdme

Links

Open Source Insights

README ¶

mdme (markdown me)

A simple cli tool to generate code and text blocks for viewing, sharing with people or with an LLM.

Installation

go install github.com/alafeefidev/mdme/cmd/mdme@latest

Usage

mdme <path> [flags]

Examples

Get files from current directory with console output suppressed

mdme -s

Get files from provided directory with verbosity of logs set to debug

mdme /examples -v

Flags

-s, --suppress suppress console output, only copy to clipboard
-v, --verbose enable debug logging
-d, --depth max directories depth (0 = unlimited)
--max-files max number of files to process

Planned Features

Flags to overwrite default ignore list
To work on files too, now it only accepts directories
Print to an .md file
and more...

Documentation ¶

Index ¶

func ErrorMsg(err error) string
func FromFile(path string) *gignore.GitIgnore
func IsDir(path string) (bool, error)
func IsHomeDir(absPath string) bool
func IsTextFile(path string) ([]byte, error)
func ToMD(files []File, root string) (string, error)
type File
- func ListFiles(root string, maxDepth, maxFiles int) ([]File, error)
type IgnoreConfig
- func (im *IgnoreConfig) Ignore(path, rel string, isDir bool) bool

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ErrorMsg ¶

func ErrorMsg(err error) string

func FromFile ¶

func FromFile(path string) *gignore.GitIgnore

func IsDir ¶

func IsDir(path string) (bool, error)

func IsHomeDir ¶ added in v0.1.2

func IsHomeDir(absPath string) bool

func IsTextFile ¶

func IsTextFile(path string) ([]byte, error)

func ToMD ¶

func ToMD(files []File, root string) (string, error)

Types ¶

type File ¶

type File struct {
	Path    string
	Content []byte
}

func ListFiles ¶

func ListFiles(root string, maxDepth, maxFiles int) ([]File, error)

type IgnoreConfig ¶

type IgnoreConfig struct {
	// contains filtered or unexported fields
}

func (*IgnoreConfig) Ignore ¶

func (im *IgnoreConfig) Ignore(path, rel string, isDir bool) bool

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
mdme command