diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index fc0d341..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,92 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). - -NOTE: As semantic versioning states all 0.y.z releases can contain breaking changes in API (flags, gRPC API, any backward compatibility) - -We use *breaking* word for marking changes that are not backward compatible (relates only to v0.y.z releases.) - -## Unreleased - -### Added - -* [#86](https://github.com/bwplotka/mdox/pull/86) Add configuration options for sending HTTP requests (to help avoid intermittent errors). -* [#180](https://github.com/bwplotka/mdox/pull/180) Allow ignoring/re-anchoring local links via localValidator. - -### Fixed - -* [#84](https://github.com/bwplotka/mdox/pull/84) Allow quotes in first header. -* [#181](https://github.com/bwplotka/mdox/pull/181) Add support for repeated markdown headers. - -### Changed - -* **breaking**: Building mdox now requires Go 1.27 or newer. - -## [v0.9.0](https://github.com/bwplotka/mdox/releases/tag/v0.9.0) - -### Added - -* [#20](https://github.com/bwplotka/mdox/pull/20) Add quotes to frontmatter -* [#25](https://github.com/bwplotka/mdox/pull/25) Add `sed` testcase for `mdox-exec` -* [#29](https://github.com/bwplotka/mdox/pull/29) Add transform command -* [#33](https://github.com/bwplotka/mdox/pull/33) Add `links.validate.config` flag -* [#40](https://github.com/bwplotka/mdox/pull/40) Add retries to link checking -* [#46](https://github.com/bwplotka/mdox/pull/46) Add support for formatting in-md HTML and comments -* [#47](https://github.com/bwplotka/mdox/pull/47) Add `backMatter` support -* [#48](https://github.com/bwplotka/mdox/pull/48) Add file line numbers to errors -* [#49](https://github.com/bwplotka/mdox/pull/49) Add CLI spinner and colored diff -* [#53](https://github.com/bwplotka/mdox/pull/53) Add profiling and metrics -* [#56](https://github.com/bwplotka/mdox/pull/56) Add benchmarks -* [#58](https://github.com/bwplotka/mdox/pull/58) Add option to preserve header (`popHeader`) -* [#66](https://github.com/bwplotka/mdox/pull/66) Add support for email `mailto:` links -* [#68](https://github.com/bwplotka/mdox/pull/68) Add newline check for `mdox-exec` output -* [#69](https://github.com/bwplotka/mdox/pull/69) Add timeout option to `links.validate.config` -* [#71](https://github.com/bwplotka/mdox/pull/71) Add `Origin.Path` to transform template -* [#75](https://github.com/bwplotka/mdox/pull/75) Add `soft-wraps` flag to preserve soft line breaks -* [#76](https://github.com/bwplotka/mdox/pull/76) Add `linkPrefixForNonMarkdownResources` to transform config -* [#78](https://github.com/bwplotka/mdox/pull/78) Add retry for 0 StatusCode - -### Fixed - -* [#16](https://github.com/bwplotka/mdox/pull/16) Fixed frontmatter issues -* [#17](https://github.com/bwplotka/mdox/pull/17) Fixed `mdox-exec` issues with --help by adding `mdox-expect-exit-code` code block directive -* [#21](https://github.com/bwplotka/mdox/pull/21) Fixed local anchor link issue -* [#26](https://github.com/bwplotka/mdox/pull/26) Fixed same link in different file error -* [#31](https://github.com/bwplotka/mdox/pull/31) Fixed `clilog` file names for link errors -* [#32](https://github.com/bwplotka/mdox/pull/32) Added support for modifying links in image URLs and fixed linking when adding extra files from outside. -* [#41](https://github.com/bwplotka/mdox/pull/41) Fixed mdox gen errors on command with = inside (common case) -* [#44](https://github.com/bwplotka/mdox/pull/44) Fixed dash header ID -* [#52](https://github.com/bwplotka/mdox/pull/52) Fixed i18n section links -* [#62](https://github.com/bwplotka/mdox/pull/62) Fixed link line number in errors - -### Changed - -* [#27](https://github.com/bwplotka/mdox/pull/27) Change from `mdox-gen-exec` to `mdox-exec` -* [#39](https://github.com/bwplotka/mdox/pull/39) Change to `efficientgo/tools/extkingpin` for pathOrContent flags -* [#45](https://github.com/bwplotka/mdox/pull/45) Change transform config flag to pathOrContent -* [#59](https://github.com/bwplotka/mdox/pull/59) Make GitHub validator smarter - -## [v0.2.1](https://github.com/bwplotka/mdox/releases/tag/v0.2.1) - -### Fixed - -* Missing dependency issue - -## [v0.2.0](https://github.com/bwplotka/mdox/releases/tag/v0.2.0) - -### Changed - -* Fixed whitespace bug in code blocks. -* Add support for links. -* Changed `--links.localise.address-regex` flag to `--links.localize.address-regex` -* Changed `--links.anchor-dir` flag to `--anchor-dir`. -* Changed `--links.validate.address-regex` flag to `--links.validate.without-address-regex`. -* Allow anchor dir to be relative. -* Improved error formatting. -* By default front matter is getting formatted now. - -## [v0.1.0](https://github.com/bwplotka/mdox/releases/tag/v0.1.0) - -Initial release. diff --git a/README.md b/README.md index 5d270b0..cfad429 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # mdox -[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/bwplotka/mdox) [![Latest Release](https://img.shields.io/github/release/bwplotka/mdox.svg?style=flat-square)](https://github.com/bwplotka/mdox/releases/latest) [![CI](https://github.com/bwplotka/mdox/workflows/go/badge.svg)](https://github.com/bwplotka/mdox/actions?query=workflow%3Ago) [![Go Report Card](https://goreportcard.com/badge/github.com/bwplotka/mdox)](https://goreportcard.com/report/github.com/bwplotka/mdox) [![Slack](https://img.shields.io/badge/join%20slack-%23mdox-brightgreen.svg)](https://cloud-native.slack.com/archives/mdox) +[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/bwplotka/mdox) [![Latest Release](https://img.shields.io/github/release/bwplotka/mdox.svg?style=flat-square)](https://github.com/bwplotka/mdox/releases/latest) [![CI](https://github.com/bwplotka/mdox/workflows/go/badge.svg)](https://github.com/bwplotka/mdox/actions?query=workflow%3Ago) [![Slack](https://img.shields.io/badge/join%20slack-%23mdox-brightgreen.svg)](https://cloud-native.slack.com/archives/mdox) `mdox` (spelled as `md docs`) is a CLI for maintaining automated, high-quality project documentation and website leveraging [GitHub Flavored Markdown](https://github.github.com/gfm/) and git. @@ -292,6 +292,8 @@ or via [bingo](https://github.com/bwplotka/bingo) if want to pin it: bingo get -u github.com/bwplotka/mdox ``` +For release notes and version history, see [GitHub Releases](https://github.com/bwplotka/mdox/releases). + ## Production Usage * [Thanos](https://github.com/thanos-io/thanos)