Skip to content

Commit 92eff63

Browse files
2024-6-7
NoteBook 1.0-SNAPSHOT-4
1 parent 3049a19 commit 92eff63

File tree

10 files changed

+68
-50
lines changed

10 files changed

+68
-50
lines changed
0 Bytes
Binary file not shown.

NoteBook/info.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
data = {
2-
'version': '1.0-SNAPSHOT-3',
2+
'version': '1.0-SNAPSHOT-4',
33
}

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
# NoteBook
22

3-
NoteBook can help you take notes with markdown.
3+
A viewer and editor of markdown on local web pages.
44

5-
Run the ```start.py``` to start.
5+
## Features
66

7+
- Based on [Python3](https://www.python.org/), [Django](http://www.djangoproject.com/) and [editor.md](https://github.com/pandao/editor.md).
8+
- Support Standard Markdown;
9+
- Support real-time preview, image upload.
10+
- Support [KaTeX](https://katex.org).
11+
12+
Please download the Python3
13+
and run the ```start.py``` to start.
14+
15+
NoteBook runs at `127.0.0.1:8014`.
16+
17+
The all notebooks are storaged in ```/notebooks/```
18+
19+
and all images are storaged in ```/image/```.
20+
21+
The host name cannot contain Chinese characters.

notebooks/demo.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

notebooks/tutorial.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Welcome
2+
3+
You need to use Markdown to read your notebooks.
4+
5+
[Here is a Markdown guide](https://www.markdownguide.org/)
6+
7+
NoteBook also support HTML editing.
8+
9+
The all notebooks are storaged in ```/notebooks/```
10+
11+
## TOC
12+
13+
You can use `[TOC]` to show the directory.
14+
15+
[TOC]
16+
17+
## Image upload and display
18+
19+
You can upload the image by clicking the **picture icon** in the top tool bar.
20+
21+
If you want to zoom a picture, you can use the HTML like this.
22+
23+
```html
24+
<img src="/image/89L2009.png" style="zoom:5%;">
25+
<img src="/image/89L2009.png" style="width:50px;">
26+
```
27+
28+
<img src="/image/89L2009.png" style="zoom:5%;">
29+
<img src="/image/89L2009.png" style="width:50px;">
30+
31+
The all images are storaged in ```/image/```.
32+
33+
## KaTeX render bug
34+
35+
There are some problem of the KaTeX.
36+
37+
You can visit [Latexlive](https://www.latexlive.com/) to download the svg image and upload it.
38+
39+

resource/notebook/editor.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ $(function() {
2121
]
2222
},
2323
imageUpload : true,
24-
imageFormats : ["jpg", "jpeg", "gif", "png", "bmp", "webp"],
24+
imageFormats : ["jpg", "jpeg", "gif", "png", "bmp", "webp", "svg"],
2525
imageUploadURL : "/upload/image/",
2626
});
2727
});

resource/notebook/main.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
h1, h2, h3, h4, h5, h6 {
1+
h1, h2, h3, h4, h5, h6, a, p {
22
font-family: Arial, Helvetica, sans-serif;
33
}
44
.main-content-left {
@@ -7,7 +7,7 @@ h1, h2, h3, h4, h5, h6 {
77
}
88
.main-content-left-card {
99
padding: 0 30px;
10-
}
10+
}
1111
.main-content-right {
1212
float: left;
1313
width: 25%;

templates/index.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ <h2>NoteBook v{{ version }}</h2>
2929
<p>{{ name }}</p>
3030
<h3>Menu</h3>
3131
<a class = "blue-link" href="/edit/new/">create new notebook</a>
32+
<h3>Useful links</h3>
33+
<a class = "blue-link" target="_blank" href="https://www.latexlive.com/">latexlive</a>
3234
</div>
3335
</div>
3436
</body>

templates/modify.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ <h2>Edit the notebook</h2>
3030
<h2>NoteBook v{{ version }}</h2>
3131
<p>Notebook: {{ title }}</p>
3232
<h3>Menu</h3>
33-
<a class="blue-link" onclick="upload_edit();">save this notebook</a>
33+
<a class="blue-link" onclick="upload_edit();">save this notebook</a><br><br>
34+
<a class="blue-link" href="/" target="_blank">return to index</a>
35+
<h3>Useful links</h3>
36+
<a class = "blue-link" target="_blank" href="https://www.latexlive.com/">latexlive</a>
3437
</div>
3538
</div>
3639
<script src="/resource/notebook/editor.js"></script>

templates/notebook.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ <h3>Menu</h3>
2929
<a class="blue-link" href="/edit/{{ title }}">edit this notebook</a> <br><br>
3030
<a class="blue-link" onclick="upload_del('{{ title }}');">delete this notebook</a> <br><br>
3131
<a class = "blue-link" href="/edit/new/">create new notebook</a>
32+
<h3>Useful links</h3>
33+
<a class = "blue-link" target="_blank" href="https://www.latexlive.com/">latexlive</a>
3234
</div>
3335
</div>
3436
<script src="/resource/notebook/editor-html-view.js"></script>

0 commit comments

Comments
 (0)