AnkiNoteTemplate/README.md

66 lines
1.7 KiB
Markdown
Raw Normal View History

2021-04-20 11:09:57 +00:00
# AnkiNoteTypes
2024-06-02 02:36:51 +00:00
<br></br><br></br>
### The "Japanese sentences" template:
2024-06-02 02:46:40 +00:00
![screenshot](/misc/2024-06-01_22-29.png)
2024-06-02 02:36:51 +00:00
- Note that this repo contains all the fonts & files needed to reproduce that template as in the picture above.
<br></br><br></br><br></br>
--
2021-11-30 20:46:27 +00:00
A collection of user-created note types for Anki 2.1. It includes a super user-friendly mechanism of importing and exporting them, and everyone is welcome to add their templates by making a pull request.
2021-04-20 11:58:53 +00:00
## Usage
2021-12-25 19:38:09 +00:00
Install [Python](https://wiki.archlinux.org/title/Python) 3.10 or later if you haven't already.
2021-12-08 23:56:08 +00:00
Clone the repository and `cd` into it.
If you have never cloned a repository before,
you need to install [git](https://git-scm.com/).
If you have `git` installed,
open your terminal and type the following commands.
```
git clone "https://github.com/Ajatt-Tools/AnkiNoteTypes.git"
cd AnkiNoteTypes
```
Make sure Anki is running, and you have
2021-04-20 11:58:53 +00:00
[AnkiConnect](https://ankiweb.net/shared/info/2055492159)
installed.
### Importing
To import one of the
[available Note Types](https://github.com/Ajatt-Tools/AnkiNoteTypes/tree/main/templates)
to Anki, run:
```
./antp.sh import
```
2021-11-30 05:01:58 +00:00
https://user-images.githubusercontent.com/69171671/143988488-ff70960c-840c-48e2-90d3-a24468da8942.mp4
2021-12-25 22:41:35 +00:00
### Updating
If you imported a note type from this collection before,
it received an update,
and you want to import the new version, run:
```
./antp.sh update
```
2021-04-20 11:58:53 +00:00
### Exporting
To export one of your Note Types, run:
```
./antp.sh export
```
Then write a helpful readme and commit your changes:
```
2021-04-20 14:42:10 +00:00
git add templates fonts && git commit
2021-04-20 11:58:53 +00:00
```
After committing your template, please [create a pull request](https://github.com/Ajatt-Tools/AnkiNoteTypes/pulls).