From 19893855dc4affeed5297c621ff83c1b415a6974 Mon Sep 17 00:00:00 2001 From: Ellpeck Date: Thu, 1 Jul 2021 05:00:59 +0200 Subject: [PATCH] added the changelog to the website --- CHANGELOG.md | 2 - Docs/docfx.json | 119 +++++++++++++-------------- Docs/index.md | 8 +- Docs/toc.yml | 4 +- MLEM.Data/MLEM.Data.csproj | 2 +- MLEM.Extended/MLEM.Extended.csproj | 2 +- MLEM.Startup/MLEM.Startup.csproj | 2 +- MLEM.Templates/MLEM.Templates.csproj | 2 +- MLEM.Ui/MLEM.Ui.csproj | 2 +- MLEM/MLEM.csproj | 2 +- 10 files changed, 71 insertions(+), 74 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7cd6dd6..813897d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,6 @@ # Changelog MLEM uses [semantic versioning](https://semver.org/). -This changelog also contains information on versions that have yet to be released. The changelog for unreleased versions might be edited over time as new features get added, changed or removed. To see the newest released version's code, check out the [release branch](https://github.com/Ellpeck/MLEM/tree/release). - Jump to version: - [5.0.0](#500) diff --git a/Docs/docfx.json b/Docs/docfx.json index 99aed9f..26da1a8 100644 --- a/Docs/docfx.json +++ b/Docs/docfx.json @@ -1,64 +1,61 @@ { - "metadata": [{ - "src": [{ - "src": "../", - "files": [ - "**.csproj" - ] - }], - "dest": "api", - "filter": "filter.yml" - }], - "build": { - "content": [{ - "files": [ - "api/**.yml" - ] - }, - { - "files": [ - "articles/**.md", - "articles/**/toc.yml", - "toc.yml", - "*.md" - ] - } + "metadata": [ + { + "src": [ + { + "src": "../", + "files": [ + "**.csproj" + ] + } + ], + "dest": "api", + "filter": "filter.yml" + } ], - "resource": [{ - "files": [ - "favicon.ico" - ] - }, { - "files": [ - "Logo.svg", - "Formatting.png", - "Ui.gif" - ], - "src": "../Media" - }], - "globalMetadata": { - "_appTitle": "MLEM Documentation", - "_appLogoPath": "Logo.svg", - "_appFooter": "© 2019-2020 Ellpeck – Impressum – Privacy" - }, - "overwrite": [{ - "files": [ - "apidoc/**.md" - ], - "exclude": [ - "obj/**", - "_site/**" - ] - }], - "dest": "_site", - "globalMetadataFiles": [], - "fileMetadataFiles": [], - "template": [ - "default", - "template" - ], - "postProcessors": [], - "markdownEngineName": "markdig", - "noLangKeyword": false - } + "build": { + "content": [ + { + "files": [ + "articles/**.md", + "articles/**/toc.yml", + "toc.yml", + "*.md", + "api/**.yml" + ] + }, + { + "files": [ + "CHANGELOG.md" + ], + "src": ".." + } + ], + "resource": [ + { + "files": [ + "favicon.ico" + ] + }, + { + "files": ["*"], + "src": "../Media" + } + ], + "globalMetadata": { + "_appTitle": "MLEM Documentation", + "_appLogoPath": "Logo.svg", + "_appFooter": "© 2019-2020 Ellpeck – Impressum – Privacy" + }, + "dest": "_site", + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default", + "template" + ], + "postProcessors": [], + "markdownEngineName": "markdig", + "noLangKeyword": false + } } \ No newline at end of file diff --git a/Docs/index.md b/Docs/index.md index 40574ec..f30b4ac 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -1,4 +1,4 @@ - + **MLEM Library for Extending MonoGame** is an addition to the game framework [MonoGame](https://www.monogame.net/) that provides extension methods, quality of life improvements and additional features like a ui system and easy input handling. @@ -8,7 +8,7 @@ - See the source code on [GitHub](https://github.com/Ellpeck/MLEM) - See tutorials and API documentation on this website - Check out [the demos](https://github.com/Ellpeck/MLEM/tree/main/Demos) on [Desktop](https://github.com/Ellpeck/MLEM/tree/main/Demos.DesktopGL) or [Android](https://github.com/Ellpeck/MLEM/tree/main/Demos.Android) -- See [the changelog](https://github.com/Ellpeck/MLEM/blob/main/CHANGELOG.md) for information on updates +- See [the changelog](../CHANGELOG.md) for information on updates # Made with MLEM - [A Breath of Spring Air](https://ellpeck.itch.io/a-breath-of-spring-air), a short platformer ([Source](https://git.ellpeck.de/Ellpeck/GreatSpringGameJam)) @@ -21,10 +21,10 @@ If you created a game with the help of MLEM, you can get it added to this list b Here are some images that show a couple of MLEM's features. MLEM.Ui in action: - + MLEM's text formatting system: - + # Friends of MLEM There are several other NuGet packages and tools that work well in combination with MonoGame and MLEM. Here are some of them: diff --git a/Docs/toc.yml b/Docs/toc.yml index 3c64b4a..f7e4a95 100644 --- a/Docs/toc.yml +++ b/Docs/toc.yml @@ -1,4 +1,6 @@ - name: Tutorials href: articles/ - name: API Documentation - href: api/ \ No newline at end of file + href: api/ +- name: Changelog + href: ../CHANGELOG.md \ No newline at end of file diff --git a/MLEM.Data/MLEM.Data.csproj b/MLEM.Data/MLEM.Data.csproj index baccf49..e3b1ba9 100644 --- a/MLEM.Data/MLEM.Data.csproj +++ b/MLEM.Data/MLEM.Data.csproj @@ -7,7 +7,7 @@ Ellpeck Simple data and network handling for MLEM Library for Extending MonoGame - See the full changelog at https://github.com/Ellpeck/MLEM/blob/main/CHANGELOG.md + See the full changelog at https://mlem.ellpeck.de/CHANGELOG monogame ellpeck mlem utility extensions data network serialize https://mlem.ellpeck.de/ https://github.com/Ellpeck/MLEM diff --git a/MLEM.Extended/MLEM.Extended.csproj b/MLEM.Extended/MLEM.Extended.csproj index a823884..cbcfbfc 100644 --- a/MLEM.Extended/MLEM.Extended.csproj +++ b/MLEM.Extended/MLEM.Extended.csproj @@ -7,7 +7,7 @@ Ellpeck MLEM Library for Extending MonoGame extension that ties in with MonoGame.Extended and other MonoGame libraries - See the full changelog at https://github.com/Ellpeck/MLEM/blob/main/CHANGELOG.md + See the full changelog at https://mlem.ellpeck.de/CHANGELOG monogame ellpeck mlem utility extensions monogame.extended extended https://mlem.ellpeck.de/ https://github.com/Ellpeck/MLEM diff --git a/MLEM.Startup/MLEM.Startup.csproj b/MLEM.Startup/MLEM.Startup.csproj index a0f85f7..8261582 100644 --- a/MLEM.Startup/MLEM.Startup.csproj +++ b/MLEM.Startup/MLEM.Startup.csproj @@ -8,7 +8,7 @@ Ellpeck MLEM Library for Extending MonoGame combined with some other useful libraries into a quick Game startup class - See the full changelog at https://github.com/Ellpeck/MLEM/blob/main/CHANGELOG.md + See the full changelog at https://mlem.ellpeck.de/CHANGELOG monogame ellpeck mlem utility extensions https://mlem.ellpeck.de/ https://github.com/Ellpeck/MLEM diff --git a/MLEM.Templates/MLEM.Templates.csproj b/MLEM.Templates/MLEM.Templates.csproj index 2e6339d..ec05447 100644 --- a/MLEM.Templates/MLEM.Templates.csproj +++ b/MLEM.Templates/MLEM.Templates.csproj @@ -14,7 +14,7 @@ MLEM Templates Ellpeck MLEM Library for Extending MonoGame cross-platform project templates - See the full changelog at https://github.com/Ellpeck/MLEM/blob/main/CHANGELOG.md + See the full changelog at https://mlem.ellpeck.de/CHANGELOG dotnet-new templates monogame ellpeck mlem utility extensions https://mlem.ellpeck.de/ https://github.com/Ellpeck/MLEM diff --git a/MLEM.Ui/MLEM.Ui.csproj b/MLEM.Ui/MLEM.Ui.csproj index e52ed81..4119c7e 100644 --- a/MLEM.Ui/MLEM.Ui.csproj +++ b/MLEM.Ui/MLEM.Ui.csproj @@ -7,7 +7,7 @@ Ellpeck A mouse, keyboard, gamepad and touch ready Ui system that features automatic anchoring, sizing and several ready-to-use element types. - See the full changelog at https://github.com/Ellpeck/MLEM/blob/main/CHANGELOG.md + See the full changelog at https://mlem.ellpeck.de/CHANGELOG monogame ellpeck mlem ui user interface graphical gui system mouse keyboard gamepad touch https://mlem.ellpeck.de/ https://github.com/Ellpeck/MLEM diff --git a/MLEM/MLEM.csproj b/MLEM/MLEM.csproj index db764d3..58596c8 100644 --- a/MLEM/MLEM.csproj +++ b/MLEM/MLEM.csproj @@ -7,7 +7,7 @@ Ellpeck MLEM Library for Extending MonoGame provides extension methods and additional features for MonoGame - See the full changelog at https://github.com/Ellpeck/MLEM/blob/main/CHANGELOG.md + See the full changelog at https://mlem.ellpeck.de/CHANGELOG monogame ellpeck mlem utility extensions https://mlem.ellpeck.de/ https://github.com/Ellpeck/MLEM