CheatSheet

Inspiration

We were inspired by the lack of concise documentation available for many third party libraries. We realised that there was a need for a concise multilingual documentation generator

What it does

CheatSheet takes a github repository and generates a concise multilingual outline of the library, showing available functions and types in a clean web format.

How we built it

Our project consists of a front-end written in Typescript on the React framework built using Parcel, and a back-end written in Go and Python. The back-end handles the lexing and parsing of the files in the github repo, it then exports the library definitions to the front-end, where they are displayed in a modern format. The user can then export it to a pdf if they desire.

Challenges we ran into

We found inter-operation between Go and Python difficult.
Centering divsiis always a challenge.

Accomplishments that we're proud of

We had to design a generic syntax representation capable of representing functions in multiple languages to unify the display format.
We got our project up, running and functional.