From 3f95a82c09340f67370f4df8f5425c93276f53c6 Mon Sep 17 00:00:00 2001 From: Wivik <48727868+Wivik@users.noreply.github.com> Date: Sun, 20 Aug 2023 21:46:30 +0200 Subject: [PATCH] doc: update doc --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ archetypes/default.md | 13 ++++++++++--- 2 files changed, 49 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aaaa01a..51b07af 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,45 @@ cover: The most comprehensive documentation of the support content is directly written in the [archetype](archetypes/default.md). +## Customize theme + +### Custom colors + +The CSS file is mostly variabilized and can be overloaded suing a `custom.css` file that will be loaded after the default style. + +```bash +├── assets +│   └── css +│   └── custom.css # 2. customize the color there +└── themes + └── vinyl-records-collection-theme + ├── assets + │   ├── css + │   │   ├── custom.css ## 1. copy this file to the site assets folder, in a 'css' sub-folder + │   │   └── style.css + +``` + +### Custom images + +You can change the background image of the header and the footer, also the default record image, by adding your own one in the site `assets` folder. + +```bash +├── assets +│   └── img +│   └── back-header.jpg # will have the priority over the one in the template +└── themes + └── vinyl-records-collection-theme + ├── assets + │   └── img + │   ├── back-footer.jpg + │   ├── back-header.jpg + │   └── default.png + +``` + +The theme expects the header and footer to be in `jpg` format, while the default record image is expected to be in `png`. + ## License Vinyl Records Collection Theme is [licensed under MIT](LICENSE). diff --git a/archetypes/default.md b/archetypes/default.md index 374073c..3f481d5 100644 --- a/archetypes/default.md +++ b/archetypes/default.md @@ -9,8 +9,8 @@ draft: true ## Label : name of the label that published the record label: Record's Label -## The band's name -band: Record's Band +## The artist's name +artist: Record's Band ## The genres this record is classified into genres: @@ -18,6 +18,7 @@ genres: ## Cover image : will be displayed in the album list and top page. ## Display a default one unless you change this value. +## Fill this value with the path of the picture located in the static folder cover: # More optional details you can use for your collection. @@ -29,8 +30,11 @@ cover: ## Disc format : 45rpm, 33rpm, 78rpm or size if you prefer. # format: 33rpm +## How many discs are there in this album ? +# number_of_discs: 1 + ## Any supplementary pictures you want to display. -## These pictures should be in the site asset folder : /assets +## These pictures should be in the site asset folder : /static ## If you put them into a sub-folder, don't forget it in the path ! # pictures: # - this-album/pict.jpg @@ -38,5 +42,8 @@ cover: ## The publish year # year: 1990 +## What is its condition, new ? used ? bad ? +# condition: + ## Below the metadata block, you can write some content such as a review or anything else you want. It'll be displayed in the album page. ---