From f3ea926c651c40652d571849b0a99fcff860eee6 Mon Sep 17 00:00:00 2001 From: Varun A P Date: Wed, 3 Jun 2020 19:57:08 +0200 Subject: Update Readme --- README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ readme.md | 80 ------------------------------------------------------------ 2 files changed, 84 insertions(+), 80 deletions(-) create mode 100644 README.md delete mode 100644 readme.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0803c84 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# Showcase theme for Hugo + +![Latest Release](https://img.shields.io/github/tag/apvarun/showcase-hugo-theme.svg) +![Showcase hugo theme](https://img.shields.io/github/license/apvarun/showcase-hugo-theme) +![Hugo generator](https://img.shields.io/badge/generator-hugo-brightgreen) + +Showcase is a minimal, single page theme for Hugo + +![Preview](https://github.com/apvarun/showcase-hugo-theme/blob/master/images/screenshot.png) + +Features: + +- Auto-generated menu +- Responsive content +- Filtering content +- Social links + +## Get the theme + +Run from the root of your Hugo site: + +```sh +git clone https://github.com/apvarun/showcase-hugo-theme.git themes/showcase +``` + +Alternatively, you can include this repository as a [git submodule](https://git-scm.com/docs/gitsubmodules). This makes it easier to update this theme if you have your Hugo site in git as well: + +```sh +git submodule add https://github.com/apvarun/showcase-hugo-theme.git themes/showcase +``` + +## Preview the theme + +Showcase theme ships with an fully configured example site. For a quick preview: + +```sh +cd themes/showcase/exampleSite/ +hugo serve --themesDir ../.. +``` + +Then visit `http://localhost:1313/` in your browser to view the example site. + +## Add content + +The following explains how to add content to your Hugo site. You can find sample content in the `exampleSite/` folder. + +### Structure: + . + ├── ... + ├── projects # Section Name + │ ├── project1 # Project 1 + │ ├── project2 # Project 2 + │ └── _index # (optional) Customize section name & + │ # default image for section contents + └── ... + + +## Configure your site + +From `exampleSite/`, copy `config.toml` to the root folder of your Hugo site and change the fields as you like. Helpful comments are provided. + +## Menu + +Menu in Showcase theme is auto-generated from the sections inside your content folder. + +## Google Analytics + +Set `googleAnalytics` in `config.toml` to activate Hugo's [internal Google Analytics template](https://gohugo.io/templates/internal/#google-analytics). + +## Issues + +If you have a question, please [open an issue](https://github.com/apvarun/showcase-hugo-theme/issues) for help and to help those who come after you. The more information you can provide, the better! + +## Contributing + +Contributions are welcome. For major changes, please open an issue first to discuss what you would like to change. + +## License + +Licensed under [MIT](LICENSE) + +## Acknowledgements + +[Madhu Akula](https://github.com/madhuakula) diff --git a/readme.md b/readme.md deleted file mode 100644 index 59c4366..0000000 --- a/readme.md +++ /dev/null @@ -1,80 +0,0 @@ -# Showcase theme for Hugo - -![Latest Release](https://img.shields.io/github/tag/apvarun/showcase-hugo-theme.svg) -![Showcase hugo theme](https://img.shields.io/github/license/apvarun/showcase-hugo-theme) -![Hugo generator](https://img.shields.io/badge/generator-hugo-brightgreen) - -Showcase is a minimal, single page theme for Hugo - -![Preview](https://github.com/apvarun/showcase-hugo-theme/blob/master/images/screenshot.png) - -Features: - -- Auto-generated menu -- Responsive content -- Filtering content -- Social links - -## Get the theme - -Run from the root of your Hugo site: - -```sh -git clone https://github.com/apvarun/showcase-hugo-theme.git themes/showcase -``` - -Alternatively, you can include this repository as a [git submodule](https://git-scm.com/docs/gitsubmodules). This makes it easier to update this theme if you have your Hugo site in git as well: - -```sh -git submodule add https://github.com/apvarun/showcase-hugo-theme.git themes/showcase -``` - -## Preview the theme - -Showcase theme ships with an fully configured example site. For a quick preview: - -```sh -cd themes/showcase/exampleSite/ -hugo serve --themesDir ../.. -``` - -Then visit `http://localhost:1313/` in your browser to view the example site. - -## Add content - -The following explains how to add content to your Hugo site. You can find sample content in the `exampleSite/` folder. - -### Structure: - . - ├── ... - ├── projects # Section Name - │ ├── project1 # Project 1 - │ ├── project2 # Project 2 - │ └── _index # (optional) Customize section name & - │ # default image for section contents - └── ... - - -## Configure your site - -From `exampleSite/`, copy `config.toml` to the root folder of your Hugo site and change the fields as you like. Helpful comments are provided. - -## Menu - -Menu in Showcase theme is auto-generated from the sections inside your content folder. - -## Google Analytics - -Set `googleAnalytics` in `config.toml` to activate Hugo's [internal Google Analytics template](https://gohugo.io/templates/internal/#google-analytics). - -## Issues - -If you have a question, please [open an issue](https://github.com/apvarun/showcase-hugo-theme/issues) for help and to help those who come after you. The more information you can provide, the better! - -## Contributing - -Contributions are welcome. For major changes, please open an issue first to discuss what you would like to change. - -## License - -Licensed under [MIT](LICENSE) \ No newline at end of file -- cgit v1.2.3