Note-taking app with LaTeX math rendering.
Project description
MX-Notes
Installation
pip
shell> pip install mx-notes
From source
shell> git clone https://github.com/amunger3/mx-notes.git
shell> cd mx-notes
shell> python setup.py install
Usage
CLI
MX-Notes can be ran from the command line with the command mx
:
shell> mx <notes-dir> --host <host> --port <port>
where notes-dir
represents the path to your desired MX-Notes directory.
Defaults
notes-dir
:~/MX-Notes
(will create directory if it doesn't exist)host
:127.0.0.1
(localhost)port
:5000
Features
Creating Notes
Notes are created by selecting the 'New' button. Setting the title is optional. Notes are saved automatically as they are edited.
Editing Notes
The note editing screen allows the user to edit the note title and content. Math symbols and their keybindings are shown on the left panel for quick access.
Listing Notes
When the app is started, the main screen is a list of notes in the specified directory. These notes are ordered by modification time. Clicking on a note's title will bring up its edit screen.
Notes Format
Notes are saved as .txt with a Markdown-style title followed by the note's content.
Developing
Requirements
python
npm
MX-Notes
Changelog
Changelog labels are any of the following:
- [BUGFIX], [CHANGE], [CODEQUALITY], [DEPENDENCY], [ENHANCEMENT], [OTHER], [TRANSLATION]
Version 0.0.3 (2021-01-04)
- [DEPENDENCY] Added UIKit and Sass compiler.
Version 0.0.2 (2021-01-04)
- [CODEQUALITY]
pathlib.Path
used overos.path
. - [ENHANCEMENT] Altered CSS slightly.
Version 0.0.1 (2021-01-03)
- [OTHER] Initialized project.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mx_notes-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f75714305b999037ae6b24352f97e9e49e196054d81bc41e1c6ff151b7ffe6f5 |
|
MD5 | 61d49e0b8e0e8bf0b8bbdae118d090b2 |
|
BLAKE2b-256 | 058113299be24052f4fd41fadd87ef5ede319d4392a074cf5fd472f45b843ee6 |