Update README.md
This commit is contained in:
parent
327234163d
commit
3864783204
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
@ -8,12 +8,24 @@ This theme is pretty basic and covers all of the essentials. All you have to do
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **light/dark mode**, depending on your preferences
|
- **dark/light mode**, depending on your preferences (dark is default)
|
||||||
- great reading experience thanks to [**Inter UI font**](https://rsms.me/inter/), made by [Rasmus Andersson](https://rsms.me/about/)
|
- great reading experience thanks to [**Inter UI font**](https://rsms.me/inter/), made by [Rasmus Andersson](https://rsms.me/about/)
|
||||||
- nice code highlighting thanks to [**PrismJS**](https://prismjs.com)
|
- nice code highlighting thanks to [**PrismJS**](https://prismjs.com)
|
||||||
- an easy way to modify the theme (**Webpack, NodeJS, PostCSS** — initial setup created by [Marcin Dziewulski](http://www.mobily.pl))
|
- an easy way to modify the theme (**Webpack, NodeJS, PostCSS** — initial setup created by [Marcin Dziewulski](http://www.mobily.pl))
|
||||||
- fully responsive
|
- fully responsive
|
||||||
|
|
||||||
|
#### Code highlighting
|
||||||
|
|
||||||
|
By default the theme is using PrismJS to color your code syntax. All you need to do is to wrap you code like this:
|
||||||
|
|
||||||
|
<pre>
|
||||||
|
```html
|
||||||
|
// your code here
|
||||||
|
```
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
**Supported languages**: css, clike, javascript, c, csharp, cpp, coffeescript, ruby, css-extras, diff, docker, elixir, elm, markup-templating, erlang, fsharp, flow, git, go, graphql, less, handlebars, java, json, kotlin, latex, markdown, makefile, objectivec, ocaml, perl, php, php-extras, sql, scss, python, jsx, typescript, reason, rust, sass, pug, swift, yaml, haml, tsx
|
||||||
|
|
||||||
## How to start
|
## How to start
|
||||||
|
|
||||||
You can download the theme manually by going to [https://github.com/panr/hugo-theme-hello-friend.git](https://github.com/panr/hugo-theme-hello-friend.git) and pasting it to `themes/hello-friend` in your root directory.
|
You can download the theme manually by going to [https://github.com/panr/hugo-theme-hello-friend.git](https://github.com/panr/hugo-theme-hello-friend.git) and pasting it to `themes/hello-friend` in your root directory.
|
||||||
|
|
Loading…
Reference in a new issue