Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
Anki Pack Starter
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
kartenaale
Templates
Anki Pack Starter
Commits
0c32a430
Commit
0c32a430
authored
9 months ago
by
Philipp Stadler
Browse files
Options
Downloads
Patches
Plain Diff
docs(starter): document how to include plain APKGs
parent
d40016ef
No related branches found
No related tags found
1 merge request
!3
docs(starter): document how to include plain APKGs
Pipeline
#13989
failed
9 months ago
Stage: build
Stage: release
Changes
2
Pipelines
3
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+25
-10
25 additions, 10 deletions
README.md
package.json
+1
-1
1 addition, 1 deletion
package.json
with
26 additions
and
11 deletions
README.md
+
25
−
10
View file @
0c32a430
# 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).
This diff is collapsed.
Click to expand it.
package.json
+
1
−
1
View file @
0c32a430
{
"version"
:
"1.0.0-starter
2
"
"version"
:
"1.0.0-starter
3
"
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment