From 7bd8acf2fb36b62154c2db7ce53954d91f891d55 Mon Sep 17 00:00:00 2001 From: Chuxin Huang Date: Mon, 8 Jun 2020 19:45:16 +1000 Subject: [PATCH 1/2] update readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 7066dfe4..53db5d1e 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,19 @@ If either of these options are given, `hugo-theme-codex` will render the social See the contents of the [example site](https://github.com/jakewies/hugo-theme-codex/tree/master/exampleSite) for more details. +You can also create additional social icons by replicating the code in `partials/social-icons.html`. For example, to add an email social icon, you can add the follwing: + +```html + +``` +Note that you also need to add the following css in corresponding css files where social icons are displayed, i.e. `about.css` and `post.css`: + +```css +.social-icons__icon--email { + background-image: url("/icons/email.svg"); +} +``` + ### Creating a blog post You can create a new blog post page by going to the root of your project and typing: @@ -76,6 +89,8 @@ hugo new blog/:blog-post.md Where `:blog-post.md` is the name of the file of your new post. +The theme supports KaTeX which renders math typesetting in markdown document. Simply turn on by `math: true` in your post. + ### Tags Right now `hugo-theme-codex` uses the `tags` taxonomy for blog posts. You can view all the blog posts of a given tag by going to `/tags/:tag-name`, where `:tag-name` is the name of your tag. From 4353231e34459f782f4c7ef4eb97d40b45e9459a Mon Sep 17 00:00:00 2001 From: Chuxin Huang Date: Mon, 8 Jun 2020 19:47:03 +1000 Subject: [PATCH 2/2] update readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 53db5d1e..2c9482fa 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,10 @@ The theme supports KaTeX which renders math typesetting in markdown document. Si Right now `hugo-theme-codex` uses the `tags` taxonomy for blog posts. You can view all the blog posts of a given tag by going to `/tags/:tag-name`, where `:tag-name` is the name of your tag. +### Favicon + +To update favicon of the site, replace the one in `static/favicon.ico` with your own. + ## Future Updates & Contributing Right now the way to customize the theme is not very user-friendly. That is the first thing to work on. If you get curious just hop into the theme directory and go exploring through the code. It's not too complicated what's going on.