https://github.com/abdnh/ankiwebify-readme
Convert Markdown readme to AnkiWeb HTML
https://github.com/abdnh/ankiwebify-readme
anki ankiweb
Last synced: 3 months ago
JSON representation
Convert Markdown readme to AnkiWeb HTML
- Host: GitHub
- URL: https://github.com/abdnh/ankiwebify-readme
- Owner: abdnh
- License: cc0-1.0
- Created: 2022-05-16T23:00:35.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-16T22:19:22.000Z (about 2 years ago)
- Last Synced: 2025-01-24T07:29:51.260Z (4 months ago)
- Topics: anki, ankiweb
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ankiwebify-readme
An ad-hoc Python script that takes a readme file written in Markdown and converts it to an HTML file containing only tags allowed in [AnkiWeb](https://ankiweb.net/about) for the description of decks and add-ons uploaded there.
It's not perfect and you'll probably need to edit the resulting file, but it may
save you some time if you use roughly the same description for your Anki add-ons uploaded to AnkiWeb
as the GitHub repository's README.md, and used to manually convert your README.md to the HTML allowed by AnkiWeb.
## Usage
```
usage: ankiwebify.py [-h] [--github NAME] [--branch BRANCH] file
Take a Markdown file and output an AnkiWeb HTML file
positional arguments:
file markdown file to convert
optional arguments:
-h, --help show this help message and exit
--github NAME GitHub repo name to convert relative links according to
--branch BRANCH GitHub repo branch to use for relative links
```
## Related
I also published another implementation of this as an extension for VS Code. You might want to check that too since it's probably easier to use if you're a VS Code user: https://github.com/abdnh/vscode-ankiwebify