Skip to content
Snippets Groups Projects
Commit 0c32a430 authored by Philipp Stadler's avatar Philipp Stadler
Browse files

docs(starter): document how to include plain APKGs

parent d40016ef
No related branches found
No related tags found
1 merge request!3docs(starter): document how to include plain APKGs
Pipeline #13989 failed
# Brand spanking new Anki Pack
Hi, do you want to build a new Anki pack? You can start with this repository!
If you want to learn, not create new content, see the user guide in
[English](https://gitlab.phaidra.org/kartenaale/getting-started-with-anki/-/blob/main/GUIDE.md)
or
[German](https://gitlab.phaidra.org/kartenaale/getting-started-with-anki/-/blob/main/ANLEITUNG.md).
## First-time setup for a new project
Create a
[new project](https://gitlab.phaidra.org/projects/new?namespace_id=2286#import_project)
......@@ -19,13 +24,23 @@ _Visibility, project features, permissions_. _CI/CD_ under _Repository_ should
be _enabled_. Customize Merge Requests and other settings to your liking (
_Pipelines must succeed_ is highly recommended).
## Importing the pack to your phone
Open the [releases section](-/releases) and click _Browse all APKGS…_. There,
click an APKG, download it, and import into Anki.
*Everything below this point is not starter-project-specific, you may want to keep it*
## Importing the pack to your phone or PC
Open the [releases section](-/releases) and click _Browse all APKGS…_ on the
newest release. There, click an APKG, download it, and import into Anki.
If you are completely new to Anki and feel a bit lost, check out the user guide
in
[English](https://gitlab.phaidra.org/kartenaale/getting-started-with-anki/-/blob/main/GUIDE.md)
or
[German](https://gitlab.phaidra.org/kartenaale/getting-started-with-anki/-/blob/main/ANLEITUNG.md).
## Contributing
To add new content to this pack, add subfolders to `content/` with a
`.apkg-spec.yaml` file in it, and data in the form of CSV, images or APKGs.
To add new content to this pack, either add `.apkg` files in the root next to
`content` to include them unchanged, OR add subfolders to `content/` with data
in the form of CSV, images or APKGs and an `.apkg-spec.yaml` file that
configures which HTML too use for the cards and how your data is laid out.
You can use the content in the starter template as your basis or just have a
look to see how it works:
......@@ -37,9 +52,9 @@ with your changes and open a merge request. Check the APKGs in the CI/CD build
job on the MR and if you are happy, merge to main.
### Releasing a new version
Bump the version number in `package.json` and merge the pull request.
Bump the version number in `package.json` in your merge request.
A new release will be created in the [releases section](-/releases) of the
project and the kartenaale whatsapp group will be notified (if you go to the
CI/CD job and link with your Whatsapp to send out the notification - restart
the job if necessary).
When your changes land on the main branch, a new release will be created in the
[releases section](-/releases) of the project and the kartenaale whatsapp group
will be notified (if you go to the CI/CD job and link with your Whatsapp to
send out the notification - restart the job if necessary).
{
"version": "1.0.0-starter2"
"version": "1.0.0-starter3"
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment