portaldacalheta.pt
  • Основен
  • Подвижен
  • Дизайн На Марката
  • Възходът На Дистанционното
  • Жизнен Цикъл На Продукта
Технология

Научете Markdown: Инструмент за писане за разработчици на софтуер



Ако сте софтуерен инженер , вероятно сте отделили много време за усъвършенстване на средата си, за да повишите производителността си. Имате любимата си IDE. Имате любимия си дебъгер. Имате любимия си инструмент за наблюдение на ефективността. Но какво ще кажете за вашия инструмент за писане на документация, ръководства и отчети? В крайна сметка писането отнема нетривиално време, нали? Всъщност е време да се заемете сериозно с инструмента си за писане.

И нека запомним това вие сте техничен , така че редакторите на WYSIWYG може и да не са най-добрият вариант за вас. Не е задължително да искате (или дори да харесвате!) Навигационни менюта, ленти с инструменти и ленти, за да форматирате текста си.



И какво, ако вместо това можете лесно да добавите всичките си стилове за форматиране директно в текста като прост вграден синтаксис, за да получите напълно форматиран текст?



Е, всъщност можете. Това е Маркдаун и това е всичко за този урок.



Когато повече е по-малко ...

Софтуерът за текстообработка е написан, за да задоволи изключително широк кръг потребители и случаи на употреба и като такъв трябва да предоставя всякакви функционалности. Но ясно е, че само малка част от тази функционалност вероятно ще бъде от значение за всеки отделен потребител. И за повечето потребители, които просто искат да създадат документ (и не е необходимо да проектират маркетингова брошура или плакат), много малка част от многото, много налични опции са от значение.

Всъщност Microsoft ясно осъзна това преди няколко години, когато преработи потребителския интерфейс на Microsoft Word в отделни функционални групи, наречени „ленти“. И все пак интересното е, че повечето потребители ще ви кажат, че са намерили новия интерфейс за по-объркващ и труден за навигация от своя предшественик.



номера на карти, които работят през 2017 г

научете намаление

Всъщност понякога повече може да бъде по-малко, когато става въпрос за лекота на използване и производителност.



... и когато по-малкото е повече

Приемете се, вие сте софтуерен инженер, а не графичен дизайнер. Просто искате да напишете това ръководство или технически документ или доклад и да приключите с него. Ще бъдете много щастливи и доволни от някои основни възможности за форматиране, като заглавия, списъци с надписи или номериране и кодови блокове. И, о, да, някои форматиране на шрифтове (получер, курсив и т.н.) също биха били полезни. Това е всичко. (И човече, ако можеш дори просто да го направиш ние , това наистина би било страхотно!)

Въведете Markdown.



Какво е Markdown?

Джон Грубер (със значителен принос от техническия гуру и интернет активист Аарон Суорц ) създаде езика Markdown през 2004 г. с целта на даването на възможност на хората „да пишат, използвайки лесен за четене, лесен за писане формат на обикновен текст и по желание да го конвертират в структурно валиден XHTML (или HTML)“.



Markdown е проектиран да се чете такъв, какъвто е, без да изглежда, че е маркиран с тагове или инструкции за форматиране (за разлика от текст, форматиран с език за маркиране като RTF или HTML, който може да бъде труден за писане и труден за четене в суров формат ).

Markdown ви позволява да пишете, използвайки лесен за четене, лесен за писане формат на обикновен текст, който след това може да бъде преобразуван в структурно валиден HTML. Така че, за да бъдем напълно точни, Маркдаун е наистина две неща :



  1. Синтаксис за форматиране на обикновен текст
  2. Софтуерен инструмент (чиято първа версия е написана на Perl), който преобразува форматирането на обикновен текст в HTML.

Markdown включва шепа прости, доста интуитивни и лесни за използване синтаксисни конвенции. Специално за вас като софтуерен инженер - който не се отклонява от необходимостта да научи и използва тези основни синтаксисни конвенции - Markdown наистина може да бъде пътят на най-малкото съпротивление между това, което искате да напишете, и да го напишете.

конвенции за синтаксис на маркиране

Научете Markdown: Първи стъпки

Markdown е лесен за научаване. Супер лесно. Можете да научите основите за пет минути и това бързо ще стане втора природа. И - точно както връзката между CSS и CSS препроцесорите - можете да използвате колкото малко или колкото искате.

Ако сте свикнали с някакви конвенции за писане на обикновен текст, тогава може би вече сте запознати с някои конвенции за маркиране, като числа или тирета в началото на изречението, за да създадете списък, звездички около дума за ударение и т.н. На. Така например, ако искате да покажете нещо в курсив, просто го увийте със звездички като *this* (за разлика от по-тромавия HTML синтаксис като this).

какво е единичен тест

По същия начин можете да посочите заглавие H1, като просто добавите префикс „#“ към вашия ред (например # Section Heading, вместо # Initiating Plugins

Initiate pluginName на контейнера си, използвайки jQuery, както следва:

Инициирайте `pluginName` на вашия контейнер, използвайки jQuery, както следва:
$(function() { $('#container').pluginName(); });
`$ (function () {$ ('# container'). pluginName ();});`

Използвайки идентификатора на нашия контейнер, можем да инициираме pluginName с метода jQuery .pluginName()

* Използвайки идентификатора на нашия контейнер, можем да инициираме `pluginName` с метода jQuery` .pluginName () `. *

За по-нататъшна помощ за започване на работа има много онлайн уроци за Markdown, които ще ви помогнат да получите най-бързата, включително a Преглед на надценката от Джон Грубер (създателят на Markdown), както и онлайн Маркдаун урок .

Синтактични анализатори и инструменти

След като напишете статията си в Markdown, ще ви е необходимо приложение, за да анализирате синтаксиса в HTML. Има няколко страхотни такива Безплатно включително:

  • StackEdit - базиран на браузъра редактор Markdown, който има няколко опции за синхронизиране с популярни услуги като Google Drive и Dropbox
  • Онлайн редактор на Kramdown - друг базиран на браузъра редактор Markdown с изключително прост интерфейс
  • Моу - най-добрият Mac-базиран писател на Markdown, който съм срещал като отвратителна опция за разработчици; тонове функции и безплатни (докато сте в бета версия) [това е, което използвах да пиша тази статия]
  • MarkdownPad страхотен редактор на Markdown за Windows
  • Текстове - хубав редактор за различни платформи (Mac и Windows); експортира в множество формати като PDF, .doc и ePub

Някои основни платформи вече са приели (или поне разрешили) използването на Markdown в своите редактори за тези, които желаят да го използват. С други, като WordPress, Evernote и Google Docs, родната поддръжка (към момента на писане на тази статия) все още не е изпечена, но потребителски решения са въведени от трети страни. Те включват:

  • Популярна нова платформа за блогове Дух , в преследване на рационализиране на онлайн писането, използва Markdown за своя редактор на съдържание.
  • За WordPress приставката Jetpack вече официално поддържа Markdown, която можете да активирате под Настройки> Дискусия ако използвате приставката. Или можете да използвате приставка като WP-Markdown което ще преобразува съдържанието на маркировката ви в HTML и обратно в Markdown, когато трябва да го редактирате.
  • За Evernote някои приложения на Markdown, като онлайн редактор Забележителна или редактора на Mac Поговорка позволяват експортиране и публикуване директно в бележки. Или ако предпочитате да използвате директно уеб приложението Evernote, можете да използвате разширение за браузър, наречено Markdown тук който преобразува избрана бележка, написана в Markdown, във форматиран текст с щракване на бутона на лентата с инструменти.
  • Google Docs все още не поддържа Markdown, но няколко редактора (като StackEdit ) ще експортира / синхронизира директно с Диск.

Недостатъците

Разбира се, с голяма простота идват и ограничения. Както вече обясних, Markdown не е написан за сложни текстообработващи задачи, изискващи разширени функции за форматиране. Ако това е, което ви трябва, Markdown не е правилният инструмент.

кое от следните е отговорен финансов директор?

Но за разработчиците, които трябва да напишат ръководство на потребителя или техническа документация или технически доклад, Markdown осигурява почти перфектен баланс между простотата и характеристиките, от които се нуждаете.

Може би най-големият недостатък - особено за нас, инженерите, които сме наркомани за контрол на промените, е невъзможността да го направим работят съвместно в Markdown и за проследяване на промени (едно забележително изключение от това обаче е StackEdit плъгин за Google Docs). И разбира се, с минимално количество усилия, човек може просто да си сътрудничи върху документ Markdown чрез git хранилище и по този начин да получи всички проследяване на промени и сътрудничество, от които обикновено се нуждае.

Заключение

И ученето на Markdown за всички ли е? Разбира се, че не. Никой инструмент никога не е.

Но ако сте софтуерен инженер, това може да е точно инструментът за писане, който сте търсили. Така че, ако все още не сте опитали, наистина трябва да го вземете за завъртане.

Дистанционна работа и глобализацията на услугите

Възходът На Дистанционното

Дистанционна работа и глобализацията на услугите
Развитие на AI проект - Как трябва да се подготвят мениджърите на проекти

Развитие на AI проект - Как трябва да се подготвят мениджърите на проекти

Тенденции

Популярни Публикации
Създавайте данни от случаен шум с генерални състезателни мрежи
Създавайте данни от случаен шум с генерални състезателни мрежи
Миналото все още присъства - преглед на вечния дизайн
Миналото все още присъства - преглед на вечния дизайн
Финансово бедствие в криза: Не можете да предскажете, можете да подготвите
Финансово бедствие в криза: Не можете да предскажете, можете да подготвите
Бруталистки уеб дизайн, минималистичен уеб дизайн и бъдещето на Web UX
Бруталистки уеб дизайн, минималистичен уеб дизайн и бъдещето на Web UX
Разширени съвети и хакове за презентация на PowerPoint
Разширени съвети и хакове за презентация на PowerPoint
 
Архитект отпред
Архитект отпред
Студената технологична война: все още тук и все още се използва
Студената технологична война: все още тук и все още се използва
Въведение в Apache Spark с примери и случаи на употреба
Въведение в Apache Spark с примери и случаи на употреба
Комодитизирани смартфони: Привеждане на 4G в развиващите се страни
Комодитизирани смартфони: Привеждане на 4G в развиващите се страни
Как да създам API за Secure Node.js GraphQL
Как да създам API за Secure Node.js GraphQL
Популярни Публикации
  • продажба на подразделение на фирма
  • принципи на примери за модел на дизайн
  • обратното извикване не е възел на функция js
  • как да разберете дали една компания е s corp или c corp
  • модулите правят невъзможна за програмистите да работят в екипи.
Категории
  • Подвижен
  • Дизайн На Марката
  • Възходът На Дистанционното
  • Жизнен Цикъл На Продукта
  • © 2022 | Всички Права Запазени

    portaldacalheta.pt