-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,16 @@ | ||
# TyTM (Typora Theme Manager) | ||
|
||
A theme package manager for Typora. It's currently in progress, not so user friendly. | ||
A theme package manager for Typora. | ||
|
||
Current features: | ||
- [x] add a theme | ||
- [x] remove a theme | ||
- [x] list installed themes | ||
- [ ] remove a theme | ||
- [ ] list installed themes | ||
|
||
## Usage: | ||
```bash | ||
./tytm.exe update | ||
./tytm.exe add <THEME_ID> | ||
./tytm.exe add <THEME_ID> --sub <SUB_THEME_ID> | ||
``` | ||
<THEME_ID> will be theme's name but use lowercase and use dash to replace whitespace. Ex: "GitHub Night" has id "github-night" | ||
```bash | ||
./tytm.exe rm <THEME_ID> | ||
./tytm.exe rm <THEME_ID> --sub <SUB_THEME_ID> | ||
``` | ||
|
||
## Build | ||
1. install rust (https://www.rust-lang.org/tools/install) | ||
2. `cargo build --release` | ||
|
||
## Contribute: | ||
|
||
### Add Package Manifest | ||
Refer to `manifest/`. Readme may be outdated. | ||
An example manifest (OneDark). The file name is same as the id. | ||
```json | ||
{ | ||
"id": "onedark", | ||
"name": "Blackout", | ||
"version": "1.0.7", | ||
"source": { | ||
"type": "Zip", | ||
"value": { | ||
"url": "https://github.com/obscurefreeman/typora_theme_blackout/releases/download/V1.0.7/blackout_theme.zip", | ||
"content": "./", | ||
"excludes": [] | ||
} | ||
}, | ||
"assets": [ ... ], | ||
"pkgs": [ ... ] | ||
} | ||
```shell | ||
./tytm add <URL> | ||
``` | ||
"id" will be theme's name but use lowercase and use dash to replace whitespace. Ex: "GitHub Night" has id "github-night" | ||
"type" can be "Zip" or "Git" | ||
- "Zip": download a zip file from web | ||
- "Git": clone a repository | ||
|
||
"content" means the root folder of css and assets. | ||
"excludes" means files in "content" but unnecessary, such as readme or license. You may also refer to `manifest/`. | ||
which the url points to the git/zip file of the theme. |