Legesher Documentation
💻 Documentation to code in any programming language using your native written✏️ language.
Programming with Legesher's dev tools empowers any developer to create without losing the art of innovation
Introduction
Welcome to the documentation of Legesher. This documentation guide is to serve beginners who are learning how to code :laptop:, developers who are using Legesher to program their projects
legesher-docs
Contributing
Before contributing, be sure to consult Legesher's contribution guidelines and language conventions. As a member of our community, you must abide by our Code Of Conduct.
Installation
legesher/legesher-docs/ repository
Follow these instructions on how to fork a repository
Once you have set up your fork of the legesher/legesher-docs repository, you'll want to clone it to your local machine. This is so you can make and test all of your personal edits before adding it to the master version of legesher/legesher-docs.
Navigate to the location on your computer where you want to host your code. Once in the appropriate folder, run the following command to clone the repository to your local machine.
git clone git@github.com:your-username/legesher-docs.git
You'll then want to navigate within the folder that was just created that contains all of the content of the forked repository. There you'll want to run the installation script to get the updated version of all the dependencies.
cd legesher-docs
cd guide
Development
We love your desire to give back, and want to make the process as welcoming to newcomers and experts as possible. We're working on developing more intuitive tutorials for individuals of all skill levels and expertise, so if you think the community would value from being walked through the steps you're going through please share!
Test Changes
When you start making changes to the code on your local branch, you'll need to test those changes. Most of the documentation is written in Markdown, you'll want to make sure everything is formatted properly. I suggest Atom's markdown-preview package to test out the file.
Legesher Projects
Legesher Developer Tools might be useful to you if:
- you are a non-native English speaker
- you are new to programming
- you work on a team with non-native English speakers
- you are a developer (simple enough)
| Project | Purpose |
|---|---|
tree-sitter-legesher-python |
Tree-sitter python grammar used by text editors allowing Legesher's languages to be implemented |
language-legesher-python |
Atom's programming language binding to allow syntax highlighting, code folding etc. to a specific grammar |
legesher-translations |
Host and API of all the language translations for written languages for code keywords / concepts |
legesher-dot-io |
Legesher's public website |
legesher-docs |
Legesher's documentation hub. Will be transitioning to a documentation host soon. |
legesher |
Git integration to collaborate with code and others in other languages |
legesher-pride |
A non-programmer's dream to contributing to open source by sharing what they know and learning what's new |
The Community
A message from our founder, Madi:
It is truly a blessing to be surrounded by a community of passionate, driven individuals who love sharing their gifts to creating better products together. Your contribution means the world to me and keeps me motivated to continue creating. This wouldn't be possible without you. From the bottom of my heart,
💛 THANK YOU!
Meet our community (full of contributors, backers, sponsors, and supporters) that give a little piece of their heart to this project. Thank you so much. (emoji key)
This project follows the all-contributors specification. Contributions of any kind are welcome and recognized.