Update README.md
Signed-off-by: hossainemruz <hossainemruz@gmail.com>
This commit is contained in:
parent
f2ced44fc6
commit
8bc6df0328
1 changed files with 48 additions and 21 deletions
49
README.md
49
README.md
|
@ -1,10 +1,10 @@
|
|||
# Toha
|
||||
|
||||
[](https://app.netlify.com/sites/toha/deploys) [](https://actions-badge.atrox.dev/hugo-toha/toha/goto?ref=master)          [](https://percy.io/b7cb60ab/hugo-toha.github.io)
|
||||
[](https://app.netlify.com/sites/toha/deploys) [](https://actions-badge.atrox.dev/hugo-toha/toha/goto?ref=main)          [](https://percy.io/b7cb60ab/hugo-toha.github.io)
|
||||
|
||||
A [Hugo](https://gohugo.io/) theme for a personal portfolio with minimalist design and responsiveness.
|
||||
|
||||

|
||||

|
||||
|
||||
- **Example Site:** [hugo-toha.github.io](https://hugo-toha.github.io)
|
||||
- **Documentation:** [toha-guides.netlify.app](https://toha-guides.netlify.app/posts)
|
||||
|
@ -48,15 +48,15 @@ Here are few screenshots from the [example site](https://hugo-toha.github.io).
|
|||
|
||||
##### Home Page Sections
|
||||
|
||||

|
||||

|
||||
|
||||
##### List Page
|
||||
|
||||

|
||||

|
||||
|
||||
##### Reading Page
|
||||
|
||||

|
||||

|
||||
|
||||
## Requirements
|
||||
|
||||
|
@ -157,7 +157,9 @@ Here, are some handy shortcodes you can use with this theme.
|
|||
|
||||
Here, are the current plan and progress of various components of this theme. The components will be prioritized based on users requests.
|
||||
|
||||
### Sections
|
||||
### 1. Portfolio Mode
|
||||
|
||||
Here is the check list for portfolio mode,
|
||||
|
||||
- [x] **Home**
|
||||
|
||||
|
@ -228,13 +230,19 @@ Here, are the current plan and progress of various components of this theme. The
|
|||
- [x] Image
|
||||
- [x] Summary
|
||||
|
||||
### List Page
|
||||
### 2. Blog Mode
|
||||
|
||||
Here is the checklist for blog mode,
|
||||
|
||||
- [ ] **Dedicated Home page**
|
||||
|
||||
- [x] **List Page**
|
||||
|
||||
- [x] Post Cards
|
||||
- [x] Sidebar
|
||||
- [x] Pagination
|
||||
|
||||
### Reading Page
|
||||
- [x] **Reading Page**
|
||||
|
||||
- [x] Hero Image
|
||||
- [x] Author Information
|
||||
|
@ -244,12 +252,30 @@ Here, are the current plan and progress of various components of this theme. The
|
|||
- [x] `Improve This Page` Button
|
||||
- [x] Disqus Comment
|
||||
|
||||
### Tracking and Comments
|
||||
### 3. Documentation Mode
|
||||
|
||||
Here is the check list for documentation mode,
|
||||
|
||||
- [ ] **Dedicated Home Page**
|
||||
- [ ] **Doc Page**
|
||||
- [ ] Redesign sidebar
|
||||
- [ ] Redesign TOC menu
|
||||
- [ ] Search Capability
|
||||
|
||||
### 4. Note Mode
|
||||
|
||||
- [ ] **Dedicated Home Page**
|
||||
- [ ] **Note Page**
|
||||
- [x] Add note view
|
||||
- [ ] Redesign sidebar
|
||||
- [ ] Add search capability
|
||||
|
||||
### 5. Tracking and Comments
|
||||
|
||||
- [x] Google Analytics
|
||||
- [x] Disqus Comment
|
||||
|
||||
### Shortcodes
|
||||
### 6. Shortcodes
|
||||
|
||||
- [x] Image
|
||||
- [x] Split Page into Multiple Column
|
||||
|
@ -257,6 +283,7 @@ Here, are the current plan and progress of various components of this theme. The
|
|||
- [x] Alert
|
||||
- [ ] Figure & sub-figure
|
||||
- [ ] Tabs
|
||||
- [x] Notes
|
||||
|
||||
## Contributing
|
||||
|
||||
|
@ -324,7 +351,7 @@ $ git commit -m "A meaningful commit message"
|
|||
$ git push my-fork my-feature-branch
|
||||
```
|
||||
|
||||
Then, open a PR against `master` branch of [hugo-toha/toha](https://github.com/hugo-toha/toha) from the `my-feature-branch` branch of your own fork.
|
||||
Then, open a PR against `main` branch of [hugo-toha/toha](https://github.com/hugo-toha/toha) from the `my-feature-branch` branch of your own fork.
|
||||
|
||||
## Attribution
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue