Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • 1.0.0-starter9
  • 1.0.0-starter8
  • 1.0.0-starter7
  • 1.0.0-starter6
  • 1.0.0-starter5
  • 1.0.0-starter3
  • 1.0.0-starter2
  • 1.0.0-starter
9 results

anki-pack

  • Clone with SSH
  • Clone with HTTPS
  • user avatar
    Philipp Stadler authored
    d40016ef
    History
    user avatar d40016ef

    Brand spanking new Anki Pack

    Hi, do you want to build a new Anki pack? You can start with this repository!

    First-time setup for a new project

    Create a new project in the Anki Packs namespace and choose Repository by URL with this repo:

    https://gitlab.phaidra.org/kartenaale/templates/anki-pack.git

    This step will also clone this README. You can change it later to remove this section and tell your users something about your pack instead.

    Next, enable Gitlab CI for your project. With this feature, your new content will produce Anki packages on Merge Requests and on the main branch. To enable, open Settings in the new Gitlab project and expand 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 and click Browse all APKGS…. There, click an APKG, download it, and import into Anki.

    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.

    You can use the content in the starter template as your basis or just have a look to see how it works:

    To get your changes back into the repository and test them, create a new branch 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.

    A new release will be created in the releases section 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).