From 67136b4d3bed3b24b334035db6fa520fadb3d06f Mon Sep 17 00:00:00 2001 From: Daniel Gilbert Date: Sun, 16 Jul 2023 23:20:58 +0200 Subject: [PATCH] Updates changelog and readme --- CHANGELOG.md | 18 ++++++++++++++++-- README.md | 9 ++++++++- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 315b5b5..b526551 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,20 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [unreleased] +## [3.0.8] - 2023-07-16 + +### Added +- The `.meta` file now allows you to add a description to each entry in your directory, either file or sub-directory. +- Markdown extensions have been activated. Now tables, footnotes and more can be parsed. +- File sizes are now parsed from Git entries. + +### Changed +- The Git implementation resorts to working copy for now. It's easier to work with. +- Awsm.css sadly hat to be removed. The original author completely disappeared. I re-implemented a basic css layout. +- A available `Readme.md` will be parsed as before, but won't show up on the directory list. + +### Fixed +- Using the temp folder explicitly now fixes some issues related to permissions on unix-based systems. ## [3.0.7] - 2023-06-14 @@ -66,7 +79,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Majority of code is now under test. -[unreleased]: https://github.com/DanielGilbert/Radia/compare/v3.0.7...HEAD +[unreleased]: https://github.com/DanielGilbert/Radia/compare/v3.0.8...HEAD +[3.0.8]: https://github.com/DanielGilbert/Radia/compare/v3.0.7...v3.0.8 [3.0.7]: https://github.com/DanielGilbert/Radia/compare/v3.0.6...v3.0.7 [3.0.6]: https://github.com/DanielGilbert/Radia/compare/v3.0.5...v3.0.6 [3.0.5]: https://github.com/DanielGilbert/Radia/compare/v3.0.4...v3.0.5 diff --git a/README.md b/README.md index 4264f45..ebafc1a 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ The name comes from the likes of [Radia Perlman](https://en.wikipedia.org/wiki/R - Works on folders and/or Git repositories - Can serve from multiple file repositories. Want your template in a different repo than your content? No Problem! - Renders Markdown files -- Respects hidden file attributes +- Respects hidden file attributes (for the git file provider, hidden files have to start with a ".") - ~~Just~~ Kinda works.™ ## Usage @@ -117,6 +117,13 @@ Another nice aspect about Radia is that it can directly display the contents of | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | | AllowListing | This boolean decides if the content of this directory will be listed on the index page. I do not recommend that for template directories or similar. | +### Meta Files +Meta files (designated by the name `.meta`) allow you to add a description to files or directories. The file is basically a [INI file](https://en.wikipedia.org/wiki/INI_file), which looks like this: +```ini +[games] +Description=Some of the games I developed lately. +``` +The section name (in brackets) is the name of file or folder that is affected by the key(s) that follow in this sections. In this case, the only key available is `Description`. So a folder called `games` would now show the description given in this example. The `.meta` file needs to be placed in the parent folder. So, if you want to give the folder `/content/games/` a description, the `.meta` file must be placed at `/content/.meta`, and the section must be called `[games]`. ## Building I really encourage you to use the existing docker image. If you really like to build Radia on your own, you can do so by running `dotnet build Radia.sln` ### Tests