-
Notifications
You must be signed in to change notification settings - Fork 189
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from chuxinh/chuxin-readme
Updating README
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
<a class="social-icons__icon social-icons__icon--email" href="mailto:[email protected]"></a> | ||
``` | ||
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,10 +89,16 @@ 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. | ||
|
||
### 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. |