[![GitHub](https://img.shields.io/github/license/MatejKastak/orglearn?style=flat-square)](https://github.com/MatejKastak/orglearn/blob/master/LICENSE)
# Orglearn
Orglearn provides toolbox for learning from your org-mode notes. It can generate mind
maps, anki decks and even pdfs textbooks.
## Modes [commands]
### Anki
Convert notes to anki deck. The converter will take all leafs of the tree (nodes
without children) and convert them into anki cards. The node title is
front-side of the card and the body is the back-side of the card.
### Mind map
Convert notes into a [mid map](https://en.wikipedia.org/wiki/Mind_map). This is a
good way to visualize the relationships between each node.
### PDF
Orglearn is able to create pdf from your notes. You can achieve similar results
converting org files to pdf using emacs. But we think that using `pandoc`
results in better looking PDFs and gives us the best way to customize the result.
To be able to convert org files to pdf you need to have `pandoc` along with `pdflatex` installed on
your system.
## Installation
The latest stable release of `orglearn` can be obtained via `pypi`:
```sh
pip install orglearn
```
If you wish to install the latest `master` branch:
```sh
git clone https://github.com/MatejKastak/orglearn && cd orglearn
python -m venv env && . env/bin/activate # In case you want to install in virtualenv.
pip install .
```
## Usage
Below are some basic examples for running orglearn:
```sh
orglearn anki file1.org # Convert org file into anki deck ./file1.apkg
orglearn anki file1.org file2.org # Convert multiple files into single deck
```
## Contributing
Contributions are highly appreciated. If you choose to contribute please read the Contribution Guidelines (TBD).
We are using the [black](https://github.com/psf/black) for the source code
formatting. To use it automatically prepare pre-commit hooks with the following
command.
```sh
pre-commit install # Install the pre-commit hooks
```
### Tests
Use the following command to run tests:
```bash
make test
```
PyPI 官网下载 | orglearn-1.1.1.tar.gz
版权申诉
45 浏览量
2022-02-10
18:30:27
上传
评论
收藏 15KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- Video_1715568338521.mp4
- 大气红外探测仪AIRS-V5-Tropospheric-CO2-Products.pdf
- ECharts 数据可视化 -单仪表盘
- 135131858118956ssm某企业危化品信息管理系统bf339.zip
- ECharts 数据可视化 -基本雷达图
- 关于RFID RC522的驱动以及简单使用 stm32+RC522 spi2通信 通过串口1读取数据
- 一套适合互联网企业使用的开源支付系统,支持多渠道服务商和普通商户模式 已对接微信支付,支付宝,云闪付官方接口,支持聚合码支付
- Javaweb仓库管理系统项目源码.zip
- 文件整理,qt项目,c++变成
- 一氧化碳物性计算小软件.exe
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈