Skip to content

Commit

Permalink
Update Superfile to superfile Name format #459 also update overview #460
Browse files Browse the repository at this point in the history
  • Loading branch information
yorukot committed Nov 14, 2024
1 parent c0a442d commit d67f59e
Show file tree
Hide file tree
Showing 11 changed files with 30 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ If applicable, add screenshots to help explain your problem.
**System information (please complete the following information):**
- OS: [e.g. iOS]
- Version [e.g. 22]
- Superfile Version [e.g. 1.1.1]
- superfile Version [e.g. 1.1.1]
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to Superfile
# Contributing to superfile

Welcome to Superfile! This document shall serve as a guide for you to follow in your journey to contributing to this project.
There are many ways to contribute to Superfile:
Welcome to superfile! This document shall serve as a guide for you to follow in your journey to contributing to this project.
There are many ways to contribute to superfile:
- Reporting Bugs
- Resolving issues
- Adding a theme
Expand Down Expand Up @@ -36,7 +36,7 @@ If no such theme exists, then you may create your own theme. Following steps wil

### Do you want to share an idea?

Superfile welcomes new ideas. If you have an idea you should first check if a similar or identical idea was presented previously or not, or check thoroughly if the idea is already present in superfile.
superfile welcomes new ideas. If you have an idea you should first check if a similar or identical idea was presented previously or not, or check thoroughly if the idea is already present in superfile.
To share your idea you can open a discussion in https://github.com/MHNightCat/superfile/discussions
There you can share your idea and if you want to work on it, you can follow the same steps as mentioned in previously.

Expand Down
2 changes: 1 addition & 1 deletion src/internal/model_render.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func (m model) sidebarRender() string {
if Config.SidebarWidth == 0 {
return ""
}
superfileTitle := sidebarTitleStyle.Render(" " + icon.SuperfileIcon + " Super File")
superfileTitle := sidebarTitleStyle.Render(" " + icon.SuperfileIcon + " superfile")
superfileTitle = ansi.Truncate(superfileTitle, Config.SidebarWidth, "")
s := superfileTitle
s += "\n"
Expand Down
6 changes: 3 additions & 3 deletions website/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ const site = 'https://superfile.netlify.app/';
export default defineConfig({
integrations: [
starlight({
title: 'Superfile',
description: `Superfile is a very fancy and modern terminal file manager that can complete the file operations you need!`,
title: 'superfile',
description: `superfile is a very fancy and modern terminal file manager that can complete the file operations you need!`,
expressiveCode: {
themes: ['dracula', 'solarized-light'],
},
Expand Down Expand Up @@ -96,7 +96,7 @@ export default defineConfig({
link: '/configure/config-file-path',
},
{
label: 'Superfile config',
label: 'superfile config',
link: '/configure/superfile-config/',
},
{
Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/configure/superfile-config.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Superfile config
title: superfile config
description: Configure your superfile
head:
- tag: title
content: Superfile config | superfile
content: superfile config | superfile
---

import CodeBlock from '../../../components/code.astro';
Expand Down
2 changes: 1 addition & 1 deletion website/src/content/docs/getting-started/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Learn how to use tutorial
description: Quickly get started with Superfile
description: Quickly get started with superfile
head:
- tag: title
content: Tutorial | superfile
Expand Down
8 changes: 4 additions & 4 deletions website/src/content/docs/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ head:
content: How to Contribute | superfile
---

# Contributing to Superfile
# Contributing to superfile

Welcome to Superfile! This document shall serve as a guide for you to follow in your journey to contributing to this project.
There are many ways to contribute to Superfile:
Welcome to superfile! This document shall serve as a guide for you to follow in your journey to contributing to this project.
There are many ways to contribute to superfile:
- Reporting Bugs
- Resolving issues
- Adding a theme
Expand Down Expand Up @@ -44,7 +44,7 @@ If no such theme exists, then you may create your own theme. Following steps wil

### Do you want to share an idea?

Superfile welcomes new ideas. If you have an idea you should first check if a similar or identical idea was presented previously or not, or check thoroughly if the idea is already present in superfile.
superfile welcomes new ideas. If you have an idea you should first check if a similar or identical idea was presented previously or not, or check thoroughly if the idea is already present in superfile.
To share your idea you can open a discussion in https://github.com/yorukot/superfile/discussions
There you can share your idea and if you want to work on it, you can follow the same steps as mentioned in previously.

Expand Down
6 changes: 3 additions & 3 deletions website/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Superfile | terminal-based file manager
description: "Superfile is a very fancy and modern terminal file manager that can complete the file operations you need!!"
title: superfile | terminal-based file manager
description: "superfile is a very fancy and modern terminal file manager that can complete the file operations you need!!"
template: splash
lastUpdated: false
editUrl: false
hero:
title: Perfect Terminal-based file manager 🚀!
tagline: "Superfile is a very fancy and modern terminal file manager that can complete the file operations you need!!"
tagline: "superfile is a very fancy and modern terminal file manager that can complete the file operations you need!!"
image:
file: ../../assets/logo.png
actions:
Expand Down
2 changes: 1 addition & 1 deletion website/src/content/docs/list/hotkey-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Hotkey list
description: Superfile hotkey list
description: superfile hotkey list
head:
- tag: title
content: Hotkey list | superfile
Expand Down
2 changes: 1 addition & 1 deletion website/src/content/docs/list/plugin-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Plugin list
description: Superfile plugin list
description: superfile plugin list
head:
- tag: title
content: Plugin list | superfile
Expand Down
12 changes: 9 additions & 3 deletions website/src/content/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ head:
content: Overview | superfile
---

![](https://github.com/yorukot/superfile/blob/main/asset/demo.png?raw=true)

> I mean I'm really not a good writer :(
So if you have any ideas and want to help me, please click on the `Edit page` below
# What is superfile?
Superfile is a modern terminal file manager crafted with a strong focus on user interface, functionality, and ease of use. Built with [Go](https://go.dev/) and [Bubble Tea](https://github.com/charmbracelet/bubbletea), it combines a visually appealing design with the simplicity of terminal tools, providing a fresh, accessible approach to file management.

# Why was superfile built?
Before creating superfile, I tried a lot of terminal file managers, but I was often disappointed by their UI design. So, I built superfile with a primary focus on delivering a refined, user-friendly interface.

# Why should I use superfile?
superfile is sleek and visually appealing, making it a great choice for lightweight file or directory tasks. While it may not be as feature-packed as some other terminal file managers, it excels in usability and design. If you’re looking for a full-featured file manager, I’d recommend tools like [Yazi](https://github.com/sxyazi/yazi) or others. However, for straightforward tasks with a clean interface, superfile is an excellent option.

0 comments on commit d67f59e

Please sign in to comment.