Markdown -> HTML -> pdf on the fly
Project description
Quickstart
Subheading
- Install mupdf (
sudo apt install mupdf
on ubuntu) - Install notetaking
- from PyPI:
pip3 install notetaking
- or from source:
git clone https://github.com/calumsbaird/notetaking.git && cd notetaking && python3 setup.py install
- from PyPI:
- Put some markdown in a text file
echo "# Title" > test.md
- Make the pdf
notetaking test.md -b
- Edit
test.md
in your favourite text editor and watch the pdf update when you save it
Test
- hello world
def fenced_code():
for i in range(10):
print("hello world")
some pseudo code
- hows this?
- italic
- bold
- both
notetaking with python
- write a file in markdown/html
- running
notetaking <file>
will convert it to a pdf and open a pdfviewer (mupdf?) - notetaking will continue to run in the background, every time the file is saved the pdf should update
- if the document is closed stop notetaking and close the pdf
- this might not be possible because different editors will edit the file in different ways
- if the pdf is closed stop notetaking
- if there are any errors we need to notify the user via the OS, hoopefully this is universal
TODO
- include easy css support
- also call notetaking from vim
- log errors in markdown syntax
- config file, maybe use envionment variables?
- better logging messages
Limitations
There is currently no way to track errors (syntax or otherwise) in the markdown, html or css you write.
I havent found any lightweight math rendering yet https://github.com/mbarkhau/markdown-katex has worked but is very slow
Can't update in realtime. Relies on linux signals when a file is saved. Could use .file.swp
but
Useful resources
- inotify to track changes to the file https://unix.stackexchange.com/questions/88399/how-to-generate-signal-interrupt-on-a-file-descriptor-in-linux
- might even be able to track changes to the vim .swp file too
- [python-markdown]: https://python-markdown.github.io/ for converted markdown and html with nested markdown into markdown
Packaging
python3 setup.py sdist bdist_wheel
python3 -m twine upload dist/*
- add
let @t=':read! screenshot %^M'
to your vimrc
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
notetaking-0.1.4.tar.gz
(1.6 MB
view hashes)
Built Distribution
Close
Hashes for notetaking-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b21ef36b2717ee428fa5cba3799f135f28670fceb4d219d70e4394758bad8c2 |
|
MD5 | 490806ba390b59bb3dabf48ad0ab6418 |
|
BLAKE2b-256 | 70fd2c768612b611cc0102c5dddd60635c7f360f0595d1ca2e337856e7d03601 |