parameterize git branch (#222)

* parameterize git branch

* docs: add param to README.md, prettier lint
This commit is contained in:
Nicholas Santiago 2021-01-21 02:03:37 -05:00 committed by GitHub
parent 4270ad6bbf
commit 83f7946136
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 5 deletions

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
```
>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/).
@ -102,8 +102,9 @@ enableEmoji: true
# Site parameters
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
gitBranch: main
# specify whether you want to write some blog posts or not
enableBlogPost: true
@ -145,12 +146,14 @@ Here, are the current plan and progress of various components of this theme. The
### Sections
- [x] **Home**
- [x] Configurable Background
- [x] Author Image
- [x] Greeting
- [x] Typing Carousel
- [x] **About**
- [x] Name and Designation
- [x] Summary
- [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] **Skills**
- [x] Skill Cards
- [x] Markdown Support
- [x] **Experiences**
- [x] Designation
- [x] Timeline
- [x] Company Overview
- [x] Responsibilities
- [ ] **Projects**
- [x] Category Filter
- [ ] Project Card
- [x] Overview
@ -181,6 +187,7 @@ Here, are the current plan and progress of various components of this theme. The
- [x] **Recent Posts**
- [ ] **Academic Career**
- [ ] Degree
- [ ] Institution
- [ ] Timeline
@ -189,6 +196,7 @@ Here, are the current plan and progress of various components of this theme. The
- [ ] Extracurricular Activities
- [ ] **Publications**
- [ ] Category Filter
- [ ] Card
- [ ] Abstract
@ -198,6 +206,7 @@ Here, are the current plan and progress of various components of this theme. The
- [ ] Gallery
- [ ] **Accomplishment / Courses**
- [ ] Overview
- [ ] 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.
- 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

View file

@ -69,6 +69,7 @@ params:
# GitHub repo URL of your site
gitRepo: https://github.com/hugo-toha/hugo-toha.github.io
gitBranch: main
# specify whether you want to write some blog posts or not
enableBlogPost: true

View file

@ -57,7 +57,7 @@
<!--- Improve this page button --->
{{ if site.Params.GitRepo }}
<div class="btn-improve-page">
<a href="{{ site.Params.GitRepo }}/edit/master/content/{{ .File.Path }}">
<a href="{{ site.Params.GitRepo }}/edit/{{ site.Params.GitBranch }}/content/{{ .File.Path }}">
<i class="fas fa-code-branch"></i>
{{ i18n "improve_this_page" }}
</a>