mirror of
https://github.com/liubinfighter/csv-lite.git
synced 2026-07-22 05:43:52 +00:00
docs: update README for clarity and formatting improvements; add missing image file | #33
This commit is contained in:
parent
be03fe676a
commit
5cf0f85a02
2 changed files with 35 additions and 31 deletions
66
README.md
66
README.md
|
|
@ -1,13 +1,15 @@
|
|||
|
||||
# CSV Lite
|
||||
|
||||
Simple enough for csv, no more fancy function you need to learn and think!
|
||||
|
||||
[中文版本Readme](./README_zh.md)
|
||||
[中文版本 Readme](./README_zh.md)
|
||||
|
||||
<!--  -->
|
||||
|
||||
<!--  -->
|
||||

|
||||
<!--  -->
|
||||
|
||||

|
||||
|
||||
> if you encounter any problems, download `test/test-sample.csv` to see what's different from the test csv file. Issue with an screenshot will help us fix it faster.
|
||||
|
||||
|
|
@ -17,44 +19,47 @@ Keep your mind on track! Don't waste time creating fancy tables.
|
|||
|
||||
A plugin designed to view and edit `CSV files` directly within Obsidian.
|
||||
|
||||
I have a plan to design my own database using json and csv only. If you have fancy idea about tables or csv, please feel free to issue (I will consider it in my new plugin) or search it in community. For in-markdown edit, I recommend `anyblock` with a much more complex syntax.
|
||||
- **View** CSV files in a clean, readable table.
|
||||
- **Search** the entire file to quickly find data (`esc` to clean).
|
||||
- **Navigate** easily with numbered rows and columns.
|
||||
- **Pin** the first column so it's always visible.
|
||||
- **Toggle** between the table view and raw source-mode.
|
||||
- **Edit** cells directly by clicking and typing.
|
||||
- **Manage** rows and columns (add, delete, move) with a simple right-click on the header.
|
||||
|
||||
## Why another csv plugin?
|
||||
I have a plan to design my own database using json and csv only. If you have fancy idea about tables or csv, please feel free to issue (I will consider it in csv-lite or my new plugin) or search it in community. <!-- For in-markdown edit, I recommend `anyblock` with a much more complex syntax. -->
|
||||
|
||||
There are so many csv plugin, why you need this one?
|
||||
## Why Another CSV Plugin?
|
||||
|
||||
Because I want to keep it **simple and stupid**.
|
||||
There are so many CSV plugins. Why choose this one?
|
||||
|
||||
And keep up with the **newest obsidian api and typings**.
|
||||
|
||||
No fancy feature, just open and edit.
|
||||
Because it is designed to be simple and straightforward. It also keeps up with the latest Obsidian API and typings. No fancy features—just open and edit.
|
||||
|
||||
## Philosophy
|
||||
|
||||
- No fancy UI, SAY NO TO
|
||||
- modals
|
||||
- sidebar
|
||||
- settingTab
|
||||
- Readme
|
||||
- Online docs & tutorials
|
||||
- All functions of the ui components above will be covered in a single File view.
|
||||
- All in TextFileView/workspace.
|
||||
- No more pollution to your vault, all metadata store in `./.obsidian/plugins/csv` in json format.
|
||||
- Every function must be completed within 3 steps:
|
||||
- No fancy UI, SAY NO TO
|
||||
- modals
|
||||
- sidebar
|
||||
- settingTab <!-- - Readme. Actually it's important to update readme, I hope you won't mention this line [#33](https://github.com/LIUBINfighter/csv-lite/issues/33) -->
|
||||
- Online docs & tutorials
|
||||
- All functions of the ui components above will be covered in a single File view.
|
||||
- All in TextFileView/workspace.
|
||||
- No more pollution to your vault, all metadata store in `./.obsidian/plugins/csv` in json format. (Currently no `data.json`)
|
||||
- Every function must be completed within 3 steps:
|
||||
0. Locate it visually
|
||||
1. Click/Hotkey
|
||||
2. Input (if needed)
|
||||
3. Confirm/Leave
|
||||
- The interface should remain minimal yet functional
|
||||
- Users shouldn't need to leave their workflow environment
|
||||
- CSV manipulation should be as natural as text editing.
|
||||
1. Click/Hotkey
|
||||
2. Input (if needed)
|
||||
3. Confirm/Leave
|
||||
- The interface should remain minimal yet functional.
|
||||
- Users shouldn't need to leave their workflow environment.
|
||||
- CSV manipulation should be as natural as text editing.
|
||||
|
||||
## Features
|
||||
|
||||
- View CSV files in table format
|
||||
- Edit CSV files within Obsidian
|
||||
- Supports standard CSV formatting
|
||||
- Compatible with Obsidian's interface
|
||||
- View CSV files in table format
|
||||
- Edit CSV files within Obsidian
|
||||
- Supports standard CSV formatting
|
||||
- Compatible with Obsidian's interface
|
||||
|
||||
## Purpose
|
||||
|
||||
|
|
@ -63,4 +68,3 @@ This plugin enhances Obsidian's functionality by allowing users to work with CSV
|
|||
## Getting Started
|
||||
|
||||
Install the plugin through Obsidian's community plugins section and start viewing your CSV files directly in your notes.
|
||||
|
||||
|
|
|
|||
BIN
asssets/1.1.0-action-menu.png
Normal file
BIN
asssets/1.1.0-action-menu.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 414 KiB |
Loading…
Reference in a new issue