msfjarvis
/
msfjarvis.dev
mirror of https://github.com/msfjarvis/msfjarvis.dev.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
Chuxin Huang 2020-06-08 19:45:16 +10:00
parent 44bdbcabc7
commit 4892a067e0
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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:youremail@example.com"></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,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.