From 0c5472eef3a4721c5dcf1d92cfd2f36f0e8b9c2f Mon Sep 17 00:00:00 2001 From: ToruNiina Date: Thu, 30 Jan 2025 01:35:34 +0900 Subject: [PATCH] doc: fix broken internal links --- docs/content.en/docs/features/toml_spec.md | 10 +++++----- docs/content.en/docs/reference/error_info.md | 10 +++++----- docs/content.en/docs/reference/format.md | 8 ++++---- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/content.en/docs/features/toml_spec.md b/docs/content.en/docs/features/toml_spec.md index 24ed1e18..a8d8171e 100644 --- a/docs/content.en/docs/features/toml_spec.md +++ b/docs/content.en/docs/features/toml_spec.md @@ -6,11 +6,11 @@ weight = 70 # TOML Language Version -You can specify the version of the TOML language and individual feature flags to use with `toml::parse` or `toml::format` through [`toml::spec`](docs/reference/spec#tomlspec). +You can specify the version of the TOML language and individual feature flags to use with `toml::parse` or `toml::format` through [`toml::spec`]({{< ref "docs/reference/spec#tomlspec" >}}). ## Specifying TOML Version -You can construct a [`toml::spec`](docs/reference/spec#tomlspec) from [`toml::semantic_version`](docs/reference/spec#tomlsemantic_version). +You can construct a [`toml::spec`]({{< ref "docs/reference/spec#tomlspec" >}}) from [`toml::semantic_version`]({{< ref "docs/reference/spec#tomlsemantic_version" >}}). ```cpp #include @@ -52,7 +52,7 @@ As such, any features related to future versions should be considered unstable. ### Parsing with Version Specification -The overload of [`toml::parse`](docs/reference/parser) takes a `toml::spec` following the file name. +The overload of [`toml::parse`]({{< ref "docs/reference/parser#parse" >}}) takes a `toml::spec` following the file name. This allows you to change the TOML version being used. @@ -68,7 +68,7 @@ int main() ### Serializing with Version Specification -The overload of [`toml::format`](docs/reference/serializer) takes a `toml::spec` following the `toml::value`. +The overload of [`toml::format`]({{< ref "docs/reference/serializer" >}}) takes a `toml::spec` following the `toml::value`. This allows you to change the TOML version being used. @@ -104,4 +104,4 @@ int main() } ``` -For a full list of all flags, refer to [`toml::spec`](docs/reference/spec#tomlspec). +For a full list of all flags, refer to [`toml::spec`]({{< ref "docs/reference/spec#tomlspec" >}}). diff --git a/docs/content.en/docs/reference/error_info.md b/docs/content.en/docs/reference/error_info.md index b25b45ce..cf118acf 100644 --- a/docs/content.en/docs/reference/error_info.md +++ b/docs/content.en/docs/reference/error_info.md @@ -84,7 +84,7 @@ Creates a new `error_info`. Must be followed by a `msg` related to `source_location` or `basic_value`. -Overloads are added in [`value.hpp`](docs/reference/value#tomlmake_error_info) when passing `toml::basic_value` instead of `source_location`. +Overloads are added in [`value.hpp`]({{< ref "docs/reference/value#tomlmake_error_info" >}}) when passing `toml::basic_value` instead of `source_location`. Possible to pass `suffix` at the end. @@ -128,7 +128,7 @@ std::string format_error(std::string title, Returns a formatted string using `format_error` for `error_info` created with `make_error_info`. -Overloads are added in [`value.hpp`](docs/reference/value#tomlformat_error) when passing `toml::basic_value` instead of `source_location`. +Overloads are added in [`value.hpp`]({{< ref "docs/reference/value#tomlformat_error" >}}) when passing `toml::basic_value` instead of `source_location`. ### Stream Operator @@ -140,6 +140,6 @@ Calls `format_error(e)` and outputs it. # Related -- [color.hpp](color.md) -- [parser.hpp](parser.md) -- [source_location.hpp](source_location.md) +- [color.hpp]({{< ref "color.md" >}}) +- [parser.hpp]({{< ref "parser.md" >}}) +- [source_location.hpp]({{< ref "source_location.md" >}}) diff --git a/docs/content.en/docs/reference/format.md b/docs/content.en/docs/reference/format.md index e17a251b..a1a9e8ae 100644 --- a/docs/content.en/docs/reference/format.md +++ b/docs/content.en/docs/reference/format.md @@ -101,7 +101,7 @@ Irregular widths are not allowed. Stores the suffix when `spec::ext_num_suffix` of toml11 extension is `true`. -cf. [spec.hpp](spec.md) +cf. [spec.hpp]({{< ref "spec.md" >}}) # `floating_format` @@ -122,7 +122,7 @@ Corresponds to `std::defaultfloat`, `std::fixed`, `std::scientific`, `std::hexfl `hexfloat` is available only if `toml::spec::ext_hex_float` is `true`. -cf. [spec.hpp](spec.md) +cf. [spec.hpp]({{< ref "spec.md" >}}) # `floating_format_info` @@ -152,7 +152,7 @@ Specifies the precision after the decimal point. Stores the suffix when `spec::ext_num_suffix` of toml11 extension is `true`. -cf. [spec.hpp](spec.md) +cf. [spec.hpp]({{< ref "spec.md" >}}) # `string_format` @@ -384,7 +384,7 @@ std::string to_string(const table_format); - Formats in the form of `a.b.c = "d"`. - `multiline_oneline` - Formats as a multiline inline table with line breaks. Available from TOML v1.1.0 onwards. - - cf. [spec.hpp](spec.md) + - cf. [spec.hpp]({{< ref "spec.md" >}}) - `implicit` - Skips implicit definitions like `[x.y.z.w]`, leaving `[x]`, `[x.y]`, `[x.y.z]` as implicit.