textler.io is a web based markdown editor for writing and editing markdown files. It also gives you the option to download your final result as a markdown or html file.
If you want to setup the project on your local machine, you need to follow the following steps:
In order to run textler.io on your machine you will need docker. Docker is a container virtualization software. If you wan't to find out more about docker, take a look at these ressources:
You will also need docker-compose. See this link here to learn more about it.
Clone the repository to your machine and run the following command from the project root:
$ docker-compose build
Once the container has been build and all dependencies are satisfied, you have to run the following command to launch the container:
$ docker-compose up
After that, the container will launch and expose port 3000. You can then open textler.io in your browser, by calling the following url: localhost:3000.
If you want to build textler.io for production, you have to run the following command from the inside of the container:
$ yarn build
A new folder called "build" will be created, with all files that you need for a production system.
- React - The frontend framework used
- markdown-it - The markdown parser
- react-ace - A port of cloud9's ACE editor for react
- react-bootstrap A port of bootstrap for react
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Kian Shahriyari - @thetruth777
- Levent Deniz- @levenzdeniz
- Jan Lüthje - @lloydcc
This project is licensed under the MIT License - see the LICENSE.md file for details