Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding latex snippets(wip) #23

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 58 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,69 @@
# LatexGo
When Latex meets JS = SuperFast builds
# LatexGo 👩‍💻
*When Latex meets JS = SuperFast builds* 💪

## Description 📖
A project inspired by the aim of improving the writing experience and make it easy for people to use the power of Latex. It is based on a simple concept of client-side compiling thus uses emscripten to convert the LLVM based Latex compiler to Javascript compiler, making it easy to compile and accessible to everyone for free.

## Development
## Development 🏗️
1. Clone the repository.
2. Start a server inside the root directory (Look at [this](https://gist.github.com/jgravois/5e73b56fa7756fd00b89) if you need help with starting a server).
3. Open the browser and go to `http://localhost:{PORT}`.


### Ideas to work on
### Checkout the current development version 💁

[LatexGo Website](https://latexgo.ipiyush.com)

## Prerequisites to contribute 👇
It is desired to have a basic understanding of :
- LLVM compilers
- Emscripten
- Caching in browsers
- Typescript

Required:
- Understanding and some experience in Nodejs

And willingness to work!📙📕📗

## Enhance your skillset 💪
Through this project you will learn:

- WebSocket connections
- Syncing with Google Cloud
- About LLVM compilers
- Good Knowledge of Emscripten
- UI Designing skills

### Ideas to work on 🙆

1. Modularize the proof of concept
2. Improve lazy loading and caching
3. Implement Authorization, Live Collaboration, File Directry Management in the editor.

## Let's get started ! 👍🏻
We have made everything easy for you! 👐
Checkout [Contribute.md](contribute.md) to know how to contribute.

## Project Admin 👨

- [Piyush Agrawal](https://github.com/poush)


## Mentor 👬

- [Aman Jain](https://github.com/jainaman224)

Have any query? Feel free to ask! 🙂

## License 📝
Refer to [LICENSE](https://github.com/poush/LatexGo/blob/master/LICENSE).

## Code of Conduct 📝
Refer to [CODE_OF_CONDUCT](https://github.com/poush/LatexGo/blob/add/activeUsers/CODE_OF_CONDUCT.md).

We are open to suggestions.If you've found a bug or want to suggest new features, you can create a [Github issue](https://github.com/poush/LatexGo/issues).

Let’s grow together!! 💛💙💛💙


25 changes: 25 additions & 0 deletions latex.snippets
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
snippet begdo
\begin{document}
${1}
\end{document}

snippet doclass
\documentclass{${1}}
snippet ti
\title{${1}}
snippet date
\date{${1}}
snippet auth
\author{${1}}
snippet begti
\begin{titlepage}
${1}
\end{titlepage}


# mentioning encoding in usepackage
snippet usepkg
\usepackage[${1}]{${2}}
# not mentioning encoding in usepackage
snippet usepkgg
\usepackage{${1}}