Skip to content

Latest commit

 

History

History
140 lines (100 loc) · 3.02 KB

README.md

File metadata and controls

140 lines (100 loc) · 3.02 KB
Raw

GDOCP - Go Documentation Parser

GDOCP (Go Documentation Parser) is a powerful CLI tool and library for generating Markdown documentation from Go source code. It offers both single-file and recursive parsing options, as well as a built-in HTTP server for browsing generated documentation.

Features

  • Parse single Go files or entire directory structures
  • Generate Markdown documentation from Go source code
  • Built-in HTTP server for browsing documentation
  • Customizable output directory
  • Syntax highlighting in the web interface

Installation

To Download GDOCP, use the following command:

go get -u github.com/andy4747/gdocp

To Install

go install github.com/andy4747/gdocp@latest

Usage

Document Format

/*
Author: Angel Dhakal
Date: 2024-08-14
File: bubble_sort.go
Problem: Bubbble sort the given array
Solution: {
Iterate through the array, compare adjacent elements, swap the elements if out of order, repeat until no swaps needed.
after each iteration of i, the leargest/smalles elements (in asc/desc respectively order) is always at the end of the array,
so, no need to iterate over the sorted portion.
}
Note:{
...
...
}
Time Complexity: O(n^2)
Space Complexity: O(1)
*/

package example

func BubbleSort(arr []int) {
	n := len(arr)
	for i := 0; i < n-1; i++ {
		swapped := false
		for j := 0; j < n-i-1; j++ {
			if arr[j] > arr[j+1] {
				arr[j], arr[j+1] = arr[j+1], arr[j]
				swapped = true
			}
		}
		if !swapped {
			break
		}
	}
}

CLI

GDOCP can be used as a command-line tool with the following options:

gdocp [options]

Options:

  • -input: Input Go file to parse (required if not using -r or -http)
  • -output: Output markdown file (default: output.md)
  • -http: Start HTTP server on the specified address (e.g., :6060)

Examples:

# Parse a single file
gdocp -input main.go -output main.md

# Start the HTTP server for browsing documentation
gdocp -http :6060

Library

You can also use GDOCP as a library in your Go projects:

import (
    "github.com/andy4747/gdocp/internal/parser"
    "github.com/andy4747/gdocp/internal/markdown"
)

// Parse a single file
fileInfo, err := parser.ParseFile("path/to/file.go")
mdContent, err := markdown.GenerateMarkdown(fileInfo)

// Generate documentation recursively
docMap, err := parser.GenerateMarkdownRecursively(".")

Web Interface

When using the -http flag, GDOCP starts a web server that allows you to browse the generated documentation. The interface includes:

  • A list of all parsed documents
  • Syntax-highlighted Markdown rendering
  • Easy navigation between files

Contributing

Contributions to GDOCP are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

Acknowledgements

GDOCP uses the following open-source libraries:

Author

[andy4747]

For more information, please open an issue on GitHub.