diff --git a/README.md b/README.md index 9a2556d..d665c5b 100644 --- a/README.md +++ b/README.md @@ -4,181 +4,15 @@ A simple and clean blog theme for Hugo. ![](https://github.com/luizdepra/hugo-coder/blob/master/images/screenshot.png) -**HugoCoder uses Asset Pipeline now!** +## Quick Start -To use this theme you need Hugo Extended Version, v0.43 or later. But, if you still want to use the old version, you can clone the [v1.0](https://github.com/luizdepra/hugo-coder/releases/tag/v1.0) release. +1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/luizdepra/hugo-coder.git themes/coder`. +2. Configure your `config.toml`. You can either use the [this minimal configuration](https://github.com/luizdepra/hugo-coder/wiki/Configurations#complete-example) as a base, or look for a complete explanation about all configurations [here](https://github.com/luizdepra/hugo-coder/wiki/Configurations). The [`config.toml`](https://github.com/luizdepra/hugo-coder/blob/master/exampleSite/config.toml) inside the [`exampleSite`](https://github.com/luizdepra/hugo-coder/tree/master/exampleSite) is also a good reference. +3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`. -## How to use this theme - -To use `hugo-coder` go through the following steps. - -### Download - -Clone this repository into your Hugo project. - -``` -git clone https://github.com/luizdepra/hugo-coder.git themes/coder -``` - -### Configuration - -Add the following lines to your `config.toml`. - -```toml -baseurl = "http://www.example.com" # Hostname (and path) to the root. -title = "johndoe" # Site title. -theme = "hugo-coder" # Set the theme. -languagecode = "en" # The site’s language code used to generate RSS. -defaultcontentlanguage = "en" # The default content language. - -paginate = 20 # Default number of pages per page in pagination. -canonifyurls = true # Enable to turn relative URLs into absolute. - -pygmentsstyle = "b2" # Color-theme or style for syntax highlighting. -pygmentscodefences = true # Enable code fence background highlighting. -pygmentscodefencesguesssyntax = true # Enable syntax guessing for code fences without specified language. - -disqusShortname = "yourdiscussshortname" # Enable or disable Disqus. - -[params] # theme parameters - author = "John Doe" # Author's name. - info = "Full Stack DevOps and Magician" # Author's job title or info. - description = "John Doe's personal website" # Site description. - keywords = "blog,developer,personal" # Site keywords. - avatarurl = "images/avatar.jpg" # Contain the path of the optionnal avatar in the static folder. - - footercontent = "Enter a text here." # Add footer content - - # Whether you want to hide copyright and credits in the footer. - hideCredits = false - hideCopyright = false - - # to switch bewteen LTR and RTL layout - rtl = false - - # Custom CSS - custom_css = [] - -# Social links -[[params.social]] - name = "Github" - icon = "fab fa-github fa-2x" - weight = 1 - url = "https://github.com/johndoe/" -[[params.social]] - name = "Gitlab" - icon = "fab fa-gitlab fa-2x" - weight = 2 - url = "https://gitlab.com/johndoe/" -[[params.social]] - name = "Twitter" - icon = "fab fa-twitter fa-2x" - weight = 3 - url = "https://twitter.com/johndoe/" - -# Menu links -[[menu.main]] - name = "Blog" - weight = 1 - url = "/posts/" -[[menu.main]] - name = "About" - weight = 2 - url = "/about/" -``` - -You can look at full working [`config.toml`](https://github.com/luizdepra/hugo-coder/blob/master/exampleSite/config.toml) inside the [exampleSite](https://github.com/luizdepra/hugo-coder/tree/master/exampleSite) folder. - -#### Multilingual mode - -To use multilingual mode, the configuration above needs to be extended by parameters for the specific languages. -Each `language` section overrides default site's parameters when that language is chosen. - -```toml -[params] - author = "John Doe" - -[languages] - [languages.en] - languagename = "English" # The language name to be displayed in the selector. - title = "John Doe" - - # You can configure the theme parameter for each language. - [languages.en.params] - info = "Full Stack DevOps and Magician" - description = "John Doe's personal website" - keywords = "blog,developer,personal" - - [languages.en.menu] # It is possible to change the menu too. - - [[languages.en.menu.main]] - name = "About" - weight = 1.0 - url = "/about/" - - [[languages.en.menu.main]] - name = "Blog" - weight = 2.0 - url = "/posts/" - - - [languages.pl] - languagename = "Polski" - title = "John Doe po polsku" - - [languages.pl.params] - description = "Strona domowa John'a Doe" - keywords = "blog,developer,strona domowa" - info = "Full Stack DevOps i Magik" - - [languages.pl.menu] - - [[languages.pl.menu.main]] - name = "O mnie" - weight = 1.0 - url = "/pl/about/" - - [[languages.pl.menu.main]] - name = "Blog" - weight = 2.0 - url = "/pl/posts/" - - -``` - -It is possible to force Hugo to render all default language content under the language code with `defaultContentLanguageInSubdir = true`. -In this case, remember to update your menus URLs (i.e. `/en/about/`). - -### Build & Test - -It is necessary to have `less` and `uglifycss` installed to build and run the demo. -Assuming that already have NodeJS/NPM installed, run `npm install -g less uglifycss`. - -To update or generate the minified CSS file: - -``` -make build -``` - -To build your site and test, run: - -``` -hugo server -``` - -To preview the exampleSite, run - -``` -make demo -``` - -The above command copies current state of the theme to exampleSite/themes and starts hugo with hugo serve -D (Go does not support Symlink directories) - -### Disqus - -Add the following line to your config, ```disqusShortname = "yourdiscussshortname"``` When this is set, all posts are disqus enabled -You can disable comments for a post by adding the following to your page meta data: ```disable_comments: true```. +## Extra Guides +* [Multilingual Mode](https://github.com/luizdepra/hugo-coder/wiki/Multilingual-Mode) ## License