Lib.rs

🌟 درباره پروژه

این یک تی‌یوئی (رابط کاربری دسکتاپ) برای dnote است.

(برگشت به بالا)

🏗️ ساخت با

• rust
• ratatui

(برگشت به بالا)

🚀 شروع به کار

این یک مثال از نحوه ارائه دستورالعمل‌ها برای تنظیم پروژه محلی شما است. برای شروع یک نسخه محلی، مراحل زیر را دنبال کنید.

🛠️ الزامات پیش‌نیاز

1. rust نصب کنید: https://rust-lang.net.cn/
2. دنوت نصب کنید: https://github.com/dnote/dnote#installation

📥 نصب

دانلود مستقیم

شما می‌توانید فایل tar.xz مطابق با سیستم‌عامل خود را از صفحه‌ی منتشرها دانلود کنید، آن را استخراج کرده و اجرای فایل باینری dnote-tui را انجام دهید.

Cargo

cargo install dnote-tui

اگر مایلید مستقیماً از شاخه اصلی نصب کنید، از

cargo install --git https://github.com/deepanchal/dnote-tui

وقتی نصب شد، تنها کافی است اجرا کنید

dnote-tui

من روش‌های نصب اضافی را ارائه خواهم داد تا پروژه به حالت پایدارتر تبدیل شود.

🏃 اجرای پروژه محلی

1. پروژه را کپی کنید.

git clone https://github.com/deepanchal/dnote-tui.git

2. به داخل پروژه بروید.

cd dnote-tui

3. توی تی‌یوئی اجرا کنید

cargo run

🐳 با Docker امتحان کنید

با استفاده از Docker به سرعت شروع به کار با dnote-tui کنید! این تنظیم شامل داده‌های آزمایشی پیش‌بارگذاری شده است تا بتوانید به طور مستقیم به بررسی ویژگی‌های TUI بپردازید.

1. پروژه را کپی کنید و به مسیر پروژه بروید

git clone https://github.com/deepanchal/dnote-tui.git
cd dnote-tui

2. برای ساخت تصویر Docker و اجرای پوسته dnote-tui با استفاده از Docker Compose، دستور زیر را اجرا کنید

docker compose run --rm dnote-tui

یا اگر ترجیح می‌دهید مستقیماً با Docker بدون Docker Compose استفاده کنید، می‌توانید مراحل زیر را دنبال کنید

# Build the docker image
docker build --build-arg RUST_VERSION=1.76.0 --build-arg DNOTE_VERSION=0.15.1 -t dnote-tui .
# Run the docker container
docker run --rm -it dnote-tui

(برگشت به بالا)

📝 استفاده

🏃 اجرا

cargo run

🏗️ ساخت

cargo build

🧪 اجرای آزمایش‌ها

cargo test

(برگشت به بالا)

🎯 نقشه راه

• تی‌یوئی پایه‌ای با سه بخش (کتاب‌ها، صفحات و محتوا) نمایش داده شود
• کاربر دنوت ایجاد شود
  • خروجی دنوت cli را به ساختارهای مورد استفاده توسط کاربر دنوت تحلیل کنید
  • 在dnote客户端中添加使用dnote cli执行写操作的方法
• 特性
  • 读取操作
    • 从dnote cli读取书籍到tui
    • 从dnote cli读取页面到tui
    • 从dnote cli读取页面内容到tui
    • 在页面部分旁边显示截断的页面内容
  • 写操作
    • 创建一个带有页面的新书籍 #19
    • 编辑页面内容 #37
    • 向书籍中添加新页面 #49
    • 将页面移动到另一本书 #60
    • 删除书籍的页面 #51
    • 删除书籍及其所有页面 #52
    • 使用弹出输入字段重命名书籍 #59
  • 搜索和导航
    • 在书籍内查找笔记 #61
    • 全局笔记搜索 #47
    • 使页面内容可滚动 #54
  • 杂项（锦上添花）
    • 允许与dnote服务器同步笔记 #50
    • 从当前配置文件解析活动模式的键绑定并显示在页脚 #64
    • 在标题面板中添加ASCII艺术 #57
    • 显示命令日志面板以显示用户正在运行的命令，就像lazygit一样 #63
    • 使用闪光效果渲染笔记的Markdown内容并使其可切换 #53

查看开放问题以获取所有建议功能（以及已知问题）的完整列表。

(برگشت به بالا)

🤝 贡献

贡献使得开源社区成为一个如此神奇的学习、灵感和创造的地方。您所做出的任何贡献都将被强烈赞赏。

如果您有改进这个项目的建议，请分支仓库并创建一个拉取请求。您也可以简单地创建一个带有“增强”标签的问题。别忘了给项目加星！再次感谢！

1. 分支项目
2. 创建您的功能分支 (git checkout -b feat/amazing-feature)
3. 提交您的更改 (git commit -m 'feat: add some amazing-feature')
4. 将更改推送到分支 (git push origin feat/amazing-feature)
5. 打开拉取请求

(برگشت به بالا)

📄 许可证

在MIT许可证下分发。有关更多信息，请参阅LICENSE。

(برگشت به بالا)