jankaritech / blog Goto Github PK
View Code? Open in Web Editor NEWBlogposts from JankariTech
Home Page: https://blog.jankaritech.com
License: GNU General Public License v3.0
Blogposts from JankariTech
Home Page: https://blog.jankaritech.com
License: GNU General Public License v3.0
currently, clicking on a tag in the detail view of a blog post opens the following url with 404 error page: https://blog.jankaritech.com/tag
As a reader, I would expect that clicking on a tag would show me a list with other blog posts with the same tag as suggested in #140.
If this functionality is not intended, then a better user experience would be provided by removing the link from the tag.
Yeah, I would prefer to use /src/assets/... paths in the blogs for local assets and after build the url path would resolve to https:///src/assets/.... Because the domain could be different.
see #66 (comment)
Everytime using URL for the images is not friendly. Path based image usages is currently possible but only with the URL preparations and this way is not 100% good due to the case of domain as mentioned above.
thx a ton @saw-jan for raising this
Since our company blog is a way to show our expertise to potential customers, it would be nice to have an option to select posts that are particularly relevant to the services our companies provides and display them by default on top of the list.
This should only affect the default sorting order, but not apply if the user has actively selected a particular sorting order (see also #129)
It seems like currently we don't have any tests for our blog, which means with each change on development side, we have to manually test if everything still works. This is not very efficient. Let's add some some tests.
TODO
we are using a lot of external images, this is not good because
ToDo:
From a user perspective, it would be nice to have a rough estimation in the blog overview about how much time it takes to read a certain blog post.
screenshot with example from https://dev.to/
The PR #126 raises the unintended side effects.
HomeView
is broken (default sort by created date)Instant solution:
Environment:
do not use the line number reference to parse
but instead, use the peek keys.
See:
Line 44 in a84666a
Also, make the linter cope with the exact change.
Options:
Valid search keywords are unable to give any search results in some cases, providing users with an empty result. This might be problem for the user, especially if they encounter difficulty in using the search features effectively
Step-1: Go to the search bar
Step-2: Search by author, assuming artur
. It will work properly and show the results.
Step-3: Search again with the word arturs
, the search result will be empty, showing the message Sorry, no results found for "arturs"
as shown in the image.
Step-4: But when we remove the s
from the word arturs
using key backspace
and become artur
in the search results, then the search result will be empty, showing the message Sorry, no results found for "artur"
as shown in the image.
Upto now, the filter and sort feature works in complete independence. But it would be nice if we can sort the filtered resut.
clicking on a tag in the blog overview leads to detail view of the given article. as a user I would expect that this would show me a list of all articles with that tag (similar to search with filter "tag") like this is the case in many popular blogs like https://dev.to/
if a blog wraps smaller headings inside a big headings like:
...
# blog title
...
## heading 1
...
### sub heading 1
...
## heading 2
then the table of content should be made collapsible w.r.t to the headings like:
Table of content
---------------------
➡️ heading 1 ⬇️
➡️ sub heading 1
➡️ heading 2
From a user perspective, I would expect that search is by default over all categories (title, tags, authors, ... and everything else that is technically possible) unless the user specifies that he/she only wants to search in a certain category. Also content search would be nice.
When the user selects a filter to narrow down the search, it would improve the user experience by
this example shows some good ways for displaying and removing filters in a intuitive, user friendly way
Originally posted by @koebel in #127 (comment)
Instead of using the date from metadata, how about using the date of a blog published (or the date of PR merged)?
A recently published blog is seen below other blogs when sorted by Date Created
, this is due to the date from metadata being used to sort.
Sorting blogs would be more logical if sorted according to the published date rather than the date when the user started to write the blog.
It seems like currently the blog posts are sorted by publication date by default. However if the sort function is selected, this is not displayed, only after actively selecting that criteria, the option is highlighted. This is not good Usability, because it doesn't show the current state of the system to the user and can cause a bit of confusion to the user, because nothing changes when selecting this option (because it's technically already selected).
What concerns sorting criteria, it is very common to give the option to change the order (newest to oldest, oldest to newest, A-Z, Z-A).
And regarding the wording, in dev.to the terms used in the filter are "Newest" and "Oldest" (which is commonly understood that this means newest to oldest and vice versa). For "Alphabetical", I assume this is title in alphabetical order?
Plus there seems to be a little bug: at some occasions changing the display order seems to be affecting the display style (tiles vs. list view)... This needs more attention to figure out what determines the change, since this is confusing to the user.
TODO
When we select a filter and refresh the page and again we switch to another filter, then the filter is reset instead of making the selected one active.
These menus can only be toggled with click on the trigger. But this is not a good from the user/reader perspective.
If the menu is open then any click outside the menu should close that menu.
For increased reader engagement it would be nice to allow readers to react to the content by giving micro feedback (emojis such as like, heart, rocket, etc.) and comments on our blog posts like this is the case in many popular blogs such as https://dev.to/
after using the deployment from the dist
branch, the images used from /src/..
is not working
maybe we've to use the public folder to store all images.
Hash mode has a bad impact on SEO (also mentioned here: https://router.vuejs.org/guide/essentials/history-mode.html#hash-mode)
Since this is a blog site, we want our blogs to reach other people and/or maybe, become a top blog site 😄
Also, Vue Router recommends HTML5
history mode.
This might not be an easy change!
CC @kiranparajuli589 @grgprarup thoughts?
For now the dark mode and font settings are just remembered for the current page. If we reload the page or start a new session, the default values are assigned.
We can preserve these settings on the browser storage so that same setting will be rendered on the next browse
In the detail page for the blog post we have sharing buttons in the left sidebar.
Social medias:
There appears to be an issue with the proper inclusion of certain HTML references within the parsed HTML content.
To replicate the issue, please visit the following URL: https://blog.jankaritech.com/#/blog/Serving%20your%20cat%20video%20using%20the%20Internet%20-%20A%20basic%20understanding%20of%20HTTP%20and%20socket%20programming%20(in%20Java)
It is suggested to consider updating the marked.js
package, as per the official documentation, to ensure compatibility and resolve the observed issue.
During the project initialization phase, the team was initially unaware of the SEO aspect pertaining to the blog. It is important to note that a comprehensive SEO strategy encompasses not only the visibility of the blog in search engine results but also its appearance when shared on social media platforms. Currently, the blog fails to appear in search results when users search for relevant content on platforms like Google (or any other search engines), as it lacks proper meta
attributes associated with each blog page.
One viable solution to address this issue is to consider utilizing https://vitepress.dev/, a tool that has been adopted by the official documentation website of VueJS. This technology demonstrates its effectiveness and compatibility with the blog's requirements.
after changing to an other article the scroll position should be the top
The UI of our blog gives the user the option to select between two types of list view, however there is no huge difference between these display options. I suggest to change the "light view / list view" to be further reduced to the essentials (e.g. removing the title image of the blog post) similar to how this is done in dev.to in certain views, so that more blog posts are displayed on first sight within the viewport when this option is selected. This will in particular be a UX improvement for mobile users, where with the current style, only 1-2 blogposts are visible even with the second display option...
Here is some design inspiration (one of the list views from dev.to)
the search bar should be fixed. Limitations known till now:
No Results
sectionAs of now we can filter search either by tag or author and by default it does search by title. It would be better if we add an extra option to the filter title
in UI as well and make user to search by anything as default initially.And based on filters user can search accordingly through filters so that the user knows through which filter the user is making a search. Also change the place holder of the input field based on the selection of the filter something like search by title
, search by tag
, search by author
.
title
filter in UIA few issues regarding usability, accessibility and user experience of our blog that I noticed:
<div class="title">
: this is not good for accessibility, there should always be a H1 tagThe link references should be supported for the markdowns. In some markdowns like http://localhost:3000/#/blog/E2E%20Testing%20with%20Cypress/Cucumber%20-%20Gherkin%20Integration, the references are rendered at the last of the parsed content. That should not happen
Investigate the match case and fix the markdowns accordingly.
Image added with markdown syntax ![image](image-url)
is not resizable and when HTML <img src="url"/>
tag is used in markdown, it is not parsed by the markdown parser.
Every heading block in a blog should have a link using which we can navigate to that portion of the blog from anywhere using a Browser.
for code blocks, it should show the highlighted syntax
Ref: https://marked.js.org/using_advanced#highlight
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.