diff options
Diffstat (limited to 'themes/m10c/README.md')
| -rw-r--r-- | themes/m10c/README.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/themes/m10c/README.md b/themes/m10c/README.md new file mode 100644 index 0000000..0472e12 --- /dev/null +++ b/themes/m10c/README.md @@ -0,0 +1,62 @@ +# m10c theme + + + +A Hugo minimalistic theme for bloggers + +## Getting started + +### Installation + +Create a new Hugo site: +```bash +$ hugo new site [path] +``` + +Clone this repository into `themes/` directory: +```bash +$ cd [path] +$ git clone https://github.com/vaga/hugo-theme-m10c.git themes/m10c +``` + +Add this line in the `config.toml` file: +```toml +theme = "m10c" +``` + +### Configuration + +In your `config.toml` file, define the following variables in `params`: + +- `author`: Name of the author +- `description`: Short description of the author +- `avatar`: Path of file containing the author avatar image + +To add a social link, add the following lines in `params`: + +``` +[[params.social]] + name = "github" + url = "https://github.com/vaga" +``` + +To change theme colors, add the following lines in `params`: + +``` +[params.style] + darkestColor = "#d35050" + darkColor = "#212121" + lightColor = "#f5e3e0" + lightestColor = "#f5f5f5" + primaryColor = "#fff" +``` + +If you want the above theme colors, you can see the [exampleSite/config.toml](/exampleSite/config.toml) file. + +## License + +This theme is released under the [**MIT**](/LICENSE.md) License. + +## Aknowledgements + +- [feather](https://feathericons.com/) - [MIT](https://github.com/feathericons/feather/blob/master/LICENSE) |