https://github.com/mmiranda/markdown-index

Generate a global index for multiple markdown files recursively
https://github.com/mmiranda/markdown-index

go golang index markdown markdown-index readme table-of-contents toc toc-generator

Last synced: 5 months ago
JSON representation

Generate a global index for multiple markdown files recursively

• Host: GitHub
• URL: https://github.com/mmiranda/markdown-index
• Owner: mmiranda
• License: mit
• Created: 2021-10-13T08:07:32.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-25T08:24:57.000Z (over 3 years ago)
• Last Synced: 2025-05-06T00:37:30.116Z (about 1 year ago)
• Topics: go, golang, index, markdown, markdown-index, readme, table-of-contents, toc, toc-generator
• Language: Go
• Homepage:
• Size: 20 MB
• Stars: 25
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - mmiranda/markdown-index - Generate a global index for multiple markdown files recursively (Go)

README

          
[![made-with-Go](https://img.shields.io/badge/Made%20with-Go-1f425f.svg)](http://golang.org)

[![codecov](https://codecov.io/gh/mmiranda/markdown-index/branch/main/graph/badge.svg?token=3B0LZEZ6XN)](https://codecov.io/gh/mmiranda/markdown-index)

[![https://goreportcard.com/report/github.com/mmiranda/markdown-index](https://goreportcard.com/badge/github.com/mmiranda/markdown-index)](https://goreportcard.com/report/github.com/mmiranda/markdown-index)

![[Test](https://github.com/mmiranda/markdown-index/actions/workflows/test-coverage.yml)](https://github.com/mmiranda/markdown-index/actions/workflows/test-coverage.yml/badge.svg)

# markdown index

Markdown-index is a library to help you generate a global index for multiple markdown files recursively in a directory, containing a summary of every file found.

![](show.gif)

## Installation

The easiest way to install it is using Homebrew:

```bash

brew tap mmiranda/apps

brew install markdown-index

```

If you prefer, you also can download the latest binary on the [release section](https://github.com/mmiranda/markdown-index/releases), or simply use the pre-built [dockerfile image](#dockerfile)

## Usage

You can use this tool using multiple ways:

### Running Local

```bash

cd some-directory

markdown-index

```

### Dockerfile

```bash

docker pull ghcr.io/mmiranda/markdown-index:latest

docker run --rm -it -v /path/to/root/md/files:/data ghcr.io/mmiranda/markdown-index:latest

```

After running the command, a new markdown file will be created containing a summary of every other file found.

## Github Actions

Yes, you can integrate this tool into your pipeline.

Check the [live-example](.github/workflows/example.yml) for GH Actions and copy it to your own repo!

## Contributing

Contributions, issues, and feature requests are welcome!

Give a ⭐️ if you like this project!

## License

[MIT](https://choosealicense.com/licenses/mit/)