https://github.com/monkeyapple/TOC-Generator-for-Bear-Note
Generating TOC(Table-of-contents) for Bear Notes users.
https://github.com/monkeyapple/TOC-Generator-for-Bear-Note
bear-notes beautifulsoup4 markdown pyqt5 python3 toc-generator
Last synced: 12 months ago
JSON representation
Generating TOC(Table-of-contents) for Bear Notes users.
- Host: GitHub
- URL: https://github.com/monkeyapple/TOC-Generator-for-Bear-Note
- Owner: monkeyapple
- Created: 2020-06-09T13:51:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-14T14:33:04.000Z (over 2 years ago)
- Last Synced: 2024-11-19T21:35:58.474Z (over 1 year ago)
- Topics: bear-notes, beautifulsoup4, markdown, pyqt5, python3, toc-generator
- Language: Python
- Homepage: https://dev.to/effylh/toc-generator-of-bear-note-4g6h
- Size: 115 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TOC-Generator for Bear Note
TOC-Generator is a tool for generating TOC(Table of contents) for Bear Note users.
## Current Version
V1.0
### V1.0 Functionalities
* Generate Markdown TOC(Table of contents) for Bear Note (with Jump links)
* Customize the position of points in unordered list
## How to Install & Run
* Clone or download the git repository
```
$ git clone https://github.com/monkeyapple/TOC-Generator-for-Bear-Note.git
```
* Create and activate a virtual environment:
```
$ virtualenv venv
$ source venv/bin/activate
```
* Install the requirements inside the app folder
```
$ pip install -r requirements.txt
```
* Run
```
$ python main.py
```
## User Interface
## How to use
1. Copy Note's Identifier: Bear Note-->Menu-->Note-->Copy Note's Identifier
2. Export Note into HTML file: Bear Note-->File-->Export Notes-->HTML file
3. Input Indentifier and import HTML file into TOC-Generator
4. (optional) Customize points before Headings
5. Run and Copy generated TOC, then paste it into Bear Note
**Example of result**
## License
GPL v3 license