docs: add param to README.md, prettier lint

This commit is contained in:
Nicholas Santiago 2021-01-20 18:43:52 -05:00
parent 5037c004e6
commit db24d903f2

View file

@ -68,7 +68,7 @@ At first, add [Toha](https://github.com/hugo-toha/toha) theme as git submodule t
$ git submodule add https://github.com/hugo-toha/toha.git themes/toha $ git submodule add https://github.com/hugo-toha/toha.git themes/toha
``` ```
>Don't use SSH URL of the theme during adding as git sub-module. Also, don't clone the theme in your `themes` directory using `git clone`. They don't work well with Github Action or Netlify. > Don't use SSH URL of the theme during adding as git sub-module. Also, don't clone the theme in your `themes` directory using `git clone`. They don't work well with Github Action or Netlify.
If you don't already have a hugo site, create one by following the step by step guide from [here](https://toha-guides.netlify.app/posts/getting-started/prepare-site/). If you don't already have a hugo site, create one by following the step by step guide from [here](https://toha-guides.netlify.app/posts/getting-started/prepare-site/).
@ -102,8 +102,9 @@ enableEmoji: true
# Site parameters # Site parameters
params: params:
# GitHub repo URL of your site # GitHub repo URL and branch of your site
gitRepo: https://github.com/hugo-toha/hugo-toha.github.io gitRepo: https://github.com/hugo-toha/hugo-toha.github.io
gitBranch: main
# specify whether you want to write some blog posts or not # specify whether you want to write some blog posts or not
enableBlogPost: true enableBlogPost: true
@ -145,12 +146,14 @@ Here, are the current plan and progress of various components of this theme. The
### Sections ### Sections
- [x] **Home** - [x] **Home**
- [x] Configurable Background - [x] Configurable Background
- [x] Author Image - [x] Author Image
- [x] Greeting - [x] Greeting
- [x] Typing Carousel - [x] Typing Carousel
- [x] **About** - [x] **About**
- [x] Name and Designation - [x] Name and Designation
- [x] Summary - [x] Summary
- [x] Markdown Support - [x] Markdown Support
@ -160,16 +163,19 @@ Here, are the current plan and progress of various components of this theme. The
- [x] Soft Skills Indicator - [x] Soft Skills Indicator
- [x] **Skills** - [x] **Skills**
- [x] Skill Cards - [x] Skill Cards
- [x] Markdown Support - [x] Markdown Support
- [x] **Experiences** - [x] **Experiences**
- [x] Designation - [x] Designation
- [x] Timeline - [x] Timeline
- [x] Company Overview - [x] Company Overview
- [x] Responsibilities - [x] Responsibilities
- [ ] **Projects** - [ ] **Projects**
- [x] Category Filter - [x] Category Filter
- [ ] Project Card - [ ] Project Card
- [x] Overview - [x] Overview
@ -181,6 +187,7 @@ Here, are the current plan and progress of various components of this theme. The
- [x] **Recent Posts** - [x] **Recent Posts**
- [ ] **Academic Career** - [ ] **Academic Career**
- [ ] Degree - [ ] Degree
- [ ] Institution - [ ] Institution
- [ ] Timeline - [ ] Timeline
@ -189,6 +196,7 @@ Here, are the current plan and progress of various components of this theme. The
- [ ] Extracurricular Activities - [ ] Extracurricular Activities
- [ ] **Publications** - [ ] **Publications**
- [ ] Category Filter - [ ] Category Filter
- [ ] Card - [ ] Card
- [ ] Abstract - [ ] Abstract
@ -198,6 +206,7 @@ Here, are the current plan and progress of various components of this theme. The
- [ ] Gallery - [ ] Gallery
- [ ] **Accomplishment / Courses** - [ ] **Accomplishment / Courses**
- [ ] Overview - [ ] Overview
- [ ] Certificate - [ ] Certificate
@ -246,7 +255,7 @@ Pull requests are most welcome and I will be happy to review. Just follow the fo
- Use as few dependencies as possible. - Use as few dependencies as possible.
- Have patience. - Have patience.
>I am not a web developer. I have created this theme for my personal needs. So, it is reasonable to have some flaws in the codes. Feel free to open issues and PRs acknowledging the problems. > I am not a web developer. I have created this theme for my personal needs. So, it is reasonable to have some flaws in the codes. Feel free to open issues and PRs acknowledging the problems.
## Local Development ## Local Development