Welcome to Markdown Toolkit! Markdown Toolkit is an application to convert Markdown to different types of files such as HTML and PDF.
Here is a sample web application of Markdown Toolkit.
- Deployment
- Do you want a new feature?
- Feature List
- Download
- Environment Setup
- Run Code
- Syntax Support
- Support Pacakages
If you want a new feature, you can open an issue in this github repository. If you want to contribute to this repository, you are welcome to do so!
git clone https://github.com/zhu-y/markdown-toolkit.git
pip install -r requirements.txt
python run.py
You can also use Gunicorn to run the program: With default number of workers:
sh gunicorn.sh
You can also change the number of workers as you want:
gunicorn -w [number of workers] -b [host]:[port] app:app
For example, if you want four workers, 127.0.0.1 as host, 4000 as port:
gunicorn -w 4 -b 127.0.0.1:4000 app:app
- Headers
- Horizontal Rule
- Unordered List
- Ordered List
- Paragraph
- Strong, Scratch, and Italics
- Images
- Links(in markdown file/websites)
- Code Segment/Inline Code
- MathJax Support
- Download as Markdown/HTML
- Local Storage
- Checkbox
- Highlight Text
- Upload Markdown File
- Code Highlight
- Table
- Workflow
- Download as PDF
- Convert HTML to Markdown
- Login
- Save Notes into User's Private Notebook
Markdown:
# H1
## H2
### H3
#### H4
##### H5
###### H6
Result:
More syntax about MathJax please refer Here.
Markdown:
$$S_{j,k} = L - \sum_{i=j}^{k-1}(c_i + 1)-C_k$$$$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$$
Result:
Markdown:
$\begin{bmatrix}a & b\\c & d\end{bmatrix}$
Result:
You can insert a table by coding:
| Tables | Are | Cool |
| ------------- |:-------------:|-----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
The result will be:
Markdown:
This is **strong**
~~Scratch this.~~
__Italics this.__
Result:
If you want to insert an image from online source, include your image address in the parentheses. For example, if you want to include the logo of google in your markdown, you can write:
Markdown:
Result:
If you want to insert an image from the same path, include the path in the parentheses. Here is an example:
Markdown:
Result:
When the image is too large or too small, you can scale the image by adding '#[scale number]' to the end of the image link.
For example, if you originally insert image by coding:
And you want to scale it, you can use:
And you can see the result as following:
Markdown:
[Markdown Toolkit Github Repo](https://github.com/zhu-y/markdown-toolkit)
Result: Markdown Toolkit Github Repo
Markdown(Python code)
def foo():
passMarkdown(C++ code)
#include<iostream>
using namespace std;
int main(){
cout << "Hello World";
}Result:
Markdown:
Text
---
Text
Result:
Markdown:
Text
⋅⋅⋅This is a sample of a paragraph. You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
Text
Result:
Markdown:
1. First Line
1. Second Line
1. Third Line
Result:
Markdown:
- First Level 1
* Second Level 1
- Second Level 2
- Third Level
- Second Level 3
+ First Level 2
Result:
Markdown:
- [ ] not checked
- [x] checked
Result:
Markdown:
##Highlight my text##
Result:
Markdown:
> This is a blockquote
This is the normal text.
Result:
To do:
- Code highlight support: highlight.js