Giter Club home page Giter Club logo

markdown-interpreter's Introduction

markdown-interpreter

Цей застосунок був розроблений для відображення Markdown у HTML.

Опис застосунку

Цей застосунок дозволяє відображати у html наступні варіанти розмітки:

**текст** = <b>текст</b>
_текст_ = <i>текст</i>
`текст' = <tt>текст</tt>

'''
**This** is preformatted
''' 

= 

**This** is preformatted

Для початку нового параграфу у md-файлі має бути два або більше знаки переходу на новий рядок.

Всі теги мають бути закриті. Також програма не приймає вкладені теги. У разі виявлення таких користувач побачить помилку та не отримає результату html.

Встановлення застосунку

Для встановлення застосунку Вам необхідно попередньо встановити Java на свою машину.

Перший варіант: використання готового JAR архіву з цього репозиторію

markdown-interpreter.jar

Після встановлення архіву, у консолі переходимо у папку з ним та можемо користуватися програмою.

Другий варіант: самостійна збірка JAR (програмний інтерфейс Intellij IDEA)

Клонуємо репозиторій і відкриваємо його в Intellij IDEA.

У меню обираємо File - Project Structure - Artifacts - + - JAR - From modules with dependencies.

Обираємо Main як головний клас та натискаємо "ОК".

Далі в меню обираємо Build - Build Artifacts - Build.

У структурі проєкту з'являється директорія "out", у якій і є наш JAR-файл. Тепер можна скопіювати його у будь-яку бажану директорію Вашого комп'ютера.

Третій варіант: самостійна збірка JAR (командний рядок)

Клонуємо репозиторій на свою машину. У консолі git під час знаходження у склонованій директорії прописуємо

jar -cf markdown-interpreter2.jar *

та шукаємо JAR-файл у директорії проєкту.

Інструкція до використання

Для використання після встановлення застосунку, знаходячись у папці з цим застосунком, потрібно прописати:

 java -jar markdown-interpreter.jar path/to/markdown.txt

для виведення результату html у консоль, або

 java -jar markdown-interpreter.jar path/to/markdown.txt --out path/to/html/file.html

для виводу результату одразу у вказаний html-файл.

У разі виявлення помилки у markdown, Вам буде про це повідомлено та програма не поверне результат.

Вказання на revert-коміт

revert-коміт

markdown-interpreter's People

Contributors

witchkaa avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.