demo.txt

%pyGroff, A tiny Syntax guide
@Subhaditya Mukherjee
# Intro
pyGroff is a tiny wrapper around groff which will let you create professional pdfs and documents in almost markdown syntax. This document is an example as well as a syntax list for easy reference. As you can see, it is also being generated by pyGroff.

# Arguments possible
## Required
- -f : input file path
- -o : output file name. (Dont give path!)
## Optional
- -l : Language string. (Default is python)
- -t : Add TOC (Default true)
- -i : Are there images (Default true)
- -d : Delete intermediates (Default true)
- -df : Different date format (Default "%B %d, %Y")
- -c : Add cover page (Default true)
- -t : Title for cover page
- -w : Convert to word (Default False)

# Image
!drag.jpg

# Main syntax

## General 
*Note that you have to remove the <>
~% <title> : Adds a title like the one in this document
~@ <author> : Author name
~< <text> : move to the center (left is default)
~> <text> : move to the right
~# <text> : Heading level 1
~## <text> : Heading level 2.. and so on
~- <text> : Lists
 ~ : if you want to use one of the above in a sentence but do not want it to be formatted. Like this document.
~* <text> : bold
~/ <text> : italics
~_ <text> : underline
~+ <text> : New page
~^: Superscript 
^(Note that this should be in a new line)

## Advanced

~| <text> : Table. Format is |[title](1;3;4;5;6,1;3;4;8;9). Separate rows with , and lines with ;
~! <image name.jpg> : Make sure it is in the same directory. Or specify the full path. Note that it will be converted to .eps format. 
~) <code> : Python code, in quotes like : "import numpy as np; z = np.random.rand(3,3);print(z)" . Please separate lines by ;
~= <equation> : One equation per line. For more examples refer below

## Need a cover page?
*Use the arguments

- -c True
- -n "Your name"
- -t "Project title"
- -d This is optional. But it can be another date format

# Limitations for now
- If you have added a title and an author, you must add a body or you will get errors
- Formatting can only be applied to the whole row
- If you are using < or > , please leave a line gap
- If you see any numbering/formatting not working, just leave a line gap. It should mostly work out. If not. File an issue

# What about code

)import numpy as np;z = np.random.rand(3,3); print(z)

# What about tables
|[Who is cool](me;me;me;you, 1;1;1;1)

# What about equations
## Further syntax specification for easier equations
- != : not equals
- >= : greater than or equals (etc etc)
- sup : superscript
- sub : subscript
- over : divided by
- pi 
- for any greek letter : just spell it out. Put spaces before and after
- cdot : circle dot
- del : grad symbol
- grad : grad symbol
- sum : sum symbol { write as from {i=1} etc }
- int : integral
- inf : infinity
- partial : partial differential symbol
- half : 1/2
- prod : product symbol
- union 
- inter : intersection

## Some examples
= a sup 3 over b sup 5
= x=3+5x-=3 + gamma
= a sup 3 sup 5 * 600
= 7 gamma + 10 delta = 100
= f ( theta ) = .8 pi r
= sum from {i=1} to inf sub 1 = 1000x

> Thank you