https://github.com/ravenstine/cnxml2md
Compile OpenStax textbook CNXML files to Markdown format.
https://github.com/ravenstine/cnxml2md
Last synced: about 2 months ago
JSON representation
Compile OpenStax textbook CNXML files to Markdown format.
- Host: GitHub
- URL: https://github.com/ravenstine/cnxml2md
- Owner: Ravenstine
- License: mit
- Created: 2016-05-20T03:03:43.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-20T03:06:07.000Z (about 9 years ago)
- Last Synced: 2024-10-14T09:45:18.726Z (8 months ago)
- Language: JavaScript
- Size: 2.93 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
cnxml2md
========
Compile [OpenStax](http://openstax.org) textbook [CNXML](http://cnx.org/contents/hQ2d68e4@10/Frequently-Asked-Questions) files to Markdown format.
I created this because OpenStax doesn't support other eReader devices besides Kindle, and Markdown is readable as well as easily transpilable into other formats like HTML, MOBI, etc. I also tend to have weird motivations.
## Installation
```npm install -g cnxml2md```
## Use
Download a .zip version of a textbook from OpenStax, which should contain directories for each chapter of said textbook along with images and **.cnxml** files.
Inside the unzipped directory, run `cnxml2md`.
## Notes
Doesn't support every CNXML element yet, and only has been tested on Biology 1.10. I suspect it will definitely fail with any mathematics textbook. But the basic concept is there for textbooks mostly made up of paragraphs and figures.
## License
The MIT License (MIT)
Copyright (c) 2016 Ben Titcomb
See `LICENSE.txt` for details.