# tw5
**Repository Path**: oeyoews/tw5
## Basic Information
- **Project Name**: tw5
- **Description**: 🐬 A Awesome Linear Notebook On Web
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: tw6
- **Homepage**: https://oeyoew.fun
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-02
- **Last Updated**: 2022-08-15
## Categories & Tags
**Categories**: Uncategorized
**Tags**: TiddlyWiki5, memo, Fish
## README
## 📢 What's the tw5?
## 🚨 NOTE
> All customize style just for current tiddlywiki5 file, not suit for vanilla tiddlywiki.
## ShowCases
- Demo: [preview address](https://oeyoew.fun) or [tw5 vercel address](https://tw5s.vercel.app/)
- Video Demo: [preview video](https://www.bilibili.com/video/BV13a411D7G6?spm_id_from=333.999.0.0)
- Code: [gitlab](https://gitlab.com/oeyoews/tw5) and [github](https://github.com/oeyoews/tw5)
|

|

|

|
| :--------------------------------------------------: | :---------------------------------------------: | ----------------------------------------------- |
## ⛴️ Features
- based web browser
- fastly visited
- customize shortkeys
- customize file struct, ui and etc
- music player and random sentence on the bottom
- fastly deploy site with multi types, like github actions, gitlab runner, vercel and etc
- background run use systemd, startup automatically
- better experience on pc and iphone
## 🧳 Install
```bash
curl -fsSL oeyoew.fun/install-tw5.sh | bash
```
## as service with user
```bash
cp tw5.service ~/.config/systemd/user
systemctl --user daemon-reload
systemctl --user start tw5.service
```
## 🏡 Running
```bash
yarn install # install dependencies
yarn start # start tiddlywiki
```
```bash
tiddlywiki folderName --init server # init new folder
```
```bash
tiddlywiki --listen port=8080 host=0.0.0.0 # listen 0.0.0.0
```
## 🌳 TODO
[TODO](docs/TODO.md)
## 🔫 CHANGELOG
[CHANGELOG](docs/CHANGELOG.md)