-
Notifications
You must be signed in to change notification settings - Fork 0
/
example.py
251 lines (203 loc) · 6.49 KB
/
example.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
import src.markdownipy.markdownipy as markdownipy
md = markdownipy.markdownipy()
md << ("Markdownipy" | md.h1)
md < ("markdownipy_logo.png" | md.image)
md < "Markdownipy is a Python library to generate markdown files using only two operators and some helpers"
md < "Markdownipy can be used in jupyter notebooks to generate markdown outputs in python cells or inside any .py file, see below for examples"
md < " `<`(lower than operator) writes text to markdown file, `|`(pipe operator) just gives property to the text" | md.h2
md < "Even this README file is genereted by markdownipy!"
md < "./example.py" | md.link("Checkout example file")
md < "Motivation" | md.h2
md < md.hline
md < """
Lately, I'm trying to write markdown documentations for different codes and I needed to put
some specs, numbers etc. so just copy-paste some tables, links.
I was trying to change some predefined strings to speed up my writing process, yet
instead of text manipulation I just wanted to make it as a library.
Sometimes I also forget markdown syntax, so this library requires no memory (I hope so, there is even no function calls) :)
Only requirement is remembering the properties of markdownipy and the rest will be handled
"""
md < md.hline
md < "Install" | md.h3
md < "pip install markdownipy" | md.code
md < md.hline
#Quick start - jupyter
md < "Quick start - example Jupyter cell" | md.h3
c = """
from markdownipy import markdownipy
from IPython.display import display,Markdown
md = markdownipy.markdownipy()
md < "hello there" | md.bold
md < "This should be a italic text" | md.italic
display(Markdown(md.print()))
"""
md < c | md.codeb("python")
md < ("See the example jupter notebook output:" | md.bold) +" " + ("jupyter_example.ipynb" | md.link("Example jupyter file"))
md < md.hline
#Quick start - python
md < "Quick start - example Python code" | md.h3
c = """
from markdownipy import markdownipy
md = markdownipy.markdownipy()
#Simple line
md < "Hello there!"
#Bold text, numbers are also allowed
md < 3.14159 | md.bold
#Italic text
md < "Above bold text is just some digits of pi" | md.italic
#One line code and codeblock
md < "One line code " | md.code
md < '''
void markdownipy_helper(int x, int y, int z):
return x*y*z
''' | md.codeb("cpp")
#Lists
md < ["Item1","Item2","Item3"]
#Tables
md < {
"Country":["Fran","Kate","Ivan"],
"Age" : [30,48,73]
}
#E-mail, links
md < "fbgencer8@gmail.com" | md.link
md < "fbgencer8@gmail.com" | md.link("My mail")
#Image
md < "./markdownipy_logo.png" | md.image
#Writing to a file, README or README.md both works!
#Even md >> sys.stdout prints the whole markdown document
md >> "README"
"""
md < c | md.codeb("python")
md < md.hline
table_list = [
("md.bold","Bold text", "`__text__`"),
("md.italic", 'Italic text', "`_text_`"),
("md.strike", 'Strikethrough text', "`~~text~~`"),
("md.code","For single line code","` `code` `"),
("md.codeb","Code fence, takes optional arg as language name","` ```code``` `"),
("md.link or md.link(link_name)","Link text",'`[link_name(optional)](link)`'),
("md.hline","Horizontal line",'`---`'),
("md.chapter","Chapter",'`Chapter_name\\n===`'),
("md.h1","Header level 1",'`# Header1`'),
("md.h2","Header level 2",'`## Header2`'),
("md.h3","Header level 3",'`### Header3`'),
("md.h4","Header level 4",'`#### Header4`'),
("md.h5","Header level 5",'`##### Header5`'),
("md.h6","Header level 6",'`###### Header6`'),
("md.image or md.image(image_name)","Image insertion",'``'),
("md.task","Task entry in a list",'`[ ] text`'),
("md.task_check","Checked task entry in a list",'`[x] text`'),
("`object` \| md.`keyword`","Pipes the above defined line property keywords to the object",''),
("md < `object`","Adds any object to document (str,dict,list,numbers etc.)",''),
("md > `file_name`","Writes document to a file",''),
("md > `stdout`","Prints the document to console",''),
("md.print()","Returns the markdown document as string",''),
("md.clear()","Clears the markdown document",''),
]
md < "Library keywords" | md.h3
md < "This table is the whole documentation of markdownipy! (Assuming md is the markdown object in python)"
table = {"Keywords":[],"Explanation":[],"Markdown equivalent":[]}
for entry in table_list:
table["Keywords"].append(entry[0])
table["Explanation"].append(entry[1])
table["Markdown equivalent"].append(entry[2])
md < table
md < md.hline
md < md.hline
#We will call this function for each section
def add_section(section_name,section_note,code):
md < section_name | md.h3
md < section_note
md < code | md.codeb("python")
md < "Output :" | md.italic
md < md.hline
exec(code)
md < md.hline
md < md.hline
#Headers
add_section("Headers","",
"""
md < "This is a chapter" | md.chapter
md < "This is header1" | md.h1
md < "This is header2" | md.h2
md < "This is header3" | md.h3
md < "This is header4" | md.h4
md < "This is header5" | md.h5
md < "This is header6" | md.h6
"""
)
#Text props
add_section("Bold, italic, strikethrough texts","",
"""
md < "This should be a bold text" | md.bold
md < "This is an italic text" | md.italic
md < "Strikethrough is banned" | md.strike
""")
#Lists
add_section("Lists","","""
md < [
"Classical mechanics" | md.bold,
[
"Newton's law of motion",
"Lagrangian Mechanics"
],
"Thermodynamics and statistical mechanics" | md.italic,
"Electromagnetism and photonics",
"Relativistic mechanics",
"Quantum mechanics, atomic physics, and molecular physics",
[
"*", #For dot bullet put bullet type
"Schrödinger equation",
"Quantum field theory",
[
"Lists can be nested :)",
"This is another liner",
[
"Oh this is getting serious" | md.strike,
"And now bunch of numbers",
[
3.1415,
2.7176,
99999,
88888
],
"Now another item"
],
],
"Quantum statistical mechanics"
],
"Optics and acoustics",
"Condensed matter physics",
"High-energy particle physics and nuclear physics",
]
""")
#Table
add_section("Table","",
"""
md < {
"Name" : ["Albert", "Paul" | md.bold, "Richard"],
"Surname" : ["Einstein" | md.italic, "Dirac" , "Feynman" | md.italic],
}
""")
#Link
add_section("Links","",
"""
md < "https://github.com/fbgencer/markdownipy" | md.link("Markdownipy website")
""")
#Image
add_section("Image","","""
md < ("markdownipy_logo.png" | md.image("Image name"))
""")
#Quote
add_section("Single line Quote","","""
md << ("With Great Power Comes Great Responsibility" | md.quote)
""")
#Task lists
add_section("Task lists","",
"""
md < ["-",
"Take the key" | md.bold | md.task,
"Cat food" | md.bold | md.task_check
]
""")
md >> "README"