Inspiration

As an avid user of LaTeX, I had frustrations with the documents it generated always being "printer friendly" i.e. Everything was broken into separate pages. This was great for documents that need to be printed, but for note-taking, served to break up the flow of information. I wanted a way to generate HTML pages to be used for notes and other non-printed documents with a blend of LaTeX and Markdown syntax.

What it does

It takes a text document using the .ntx file extension and compiles it into an HTML file to be rendered with a browser. It has a plugin system that can be used to generate more complex elements

How we built it

This project was built using Go. This was my first real project using go and was equal parts a learning exercise to familiarize myself with the language.

Challenges we ran into

The current parser does not use a proper parse tree to be used for the rest of the program, this required a patchwork of if statements to make sure a line is parsed correctly.

Accomplishments that we're proud of

The plugin system makes it simple to extend functionality and can be written in any language

What we learned

Even with a very simple syntax, parsers are somewhat complex to write

What's next for Notex

  • Rewrite parser to generate a parse tree
  • Update certain syntax choices

Built With

Share this project:

Updates