From 518ebd1fac25689001b841c40177d38e3793e6ad Mon Sep 17 00:00:00 2001 From: Michael Goerz Date: Mon, 1 Jan 2024 23:09:29 -0500 Subject: [PATCH] Release 0.2.0 --- Project.toml | 4 ++-- docs/src/index.md | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/Project.toml b/Project.toml index fd8adad..3ad3ead 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "DocumenterInterLinks" uuid = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656" authors = ["Michael Goerz "] -version = "0.1.0+dev" +version = "0.2.0" [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" @@ -11,7 +11,7 @@ MarkdownAST = "d0879d2d-cac2-40c8-9cee-1863dc0c7391" [compat] Documenter = "1" -DocInventories = ">=0.1" +DocInventories = "0.2.0" Markdown = "1" MarkdownAST = "0.1.2" julia = "1.6" diff --git a/docs/src/index.md b/docs/src/index.md index 219a570..37dc232 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,5 +1,32 @@ # DocumenterInterLinks.jl + +```@eval +using Markdown +using Pkg + +VERSION = Pkg.dependencies()[Base.UUID("d12716ef-a0f6-4df4-a9f1-a5a34e75c656")].version + +github_badge = "[![Github](https://img.shields.io/badge/JuliaDocs-DocumenterInterLinks.jl-blue.svg?logo=github)](https://github.com/JuliaDocs/DocumenterInterLinks.jl)" + +version_badge = "![v$VERSION](https://img.shields.io/badge/version-v$(replace("$VERSION", "-" => "--"))-green.svg)" + +if get(ENV, "DOCUMENTER_BUILD_PDF", "") == "" + Markdown.parse("$github_badge $version_badge") +else + Markdown.parse(""" + ----- + + On Github: [JuliaDocs/DocumenterInterLinks.jl](https://github.com/JuliaDocs/DocumenterInterLinks.jl) + + Version: $VERSION + + ----- + + """) +end +``` + [DocumenterInterLinks.jl](https://github.com/JuliaDocs/DocumenterInterLinks.jl#readme) is a plugin for [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) to link to external projects. It is interoperable with [InterSphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html). ## Usage