เทคโนโลยี

เรียนรู้ Markdown: เครื่องมือการเขียนสำหรับนักพัฒนาซอฟต์แวร์



ถ้าคุณเป็น วิศวกรรมซอฟต์แวร์ คุณอาจใช้เวลาส่วนใหญ่ในการปรับแต่งสภาพแวดล้อมเพื่อเพิ่มผลผลิตของคุณ คุณมี IDE ที่คุณชื่นชอบ คุณมีโปรแกรมแก้ไขจุดบกพร่องที่คุณชื่นชอบ คุณมีเครื่องมือตรวจสอบประสิทธิภาพที่คุณชื่นชอบ แต่เครื่องมือสำหรับเขียนเอกสารคู่มือและรายงานของคุณล่ะ? ท้ายที่สุดแล้วการเขียนใช้เวลาส่วนใหญ่ไม่ใช่เรื่องสำคัญใช่หรือไม่? ถึงเวลาจริงจังกับเครื่องมือเขียนของคุณแล้ว

และโปรดจำไว้ว่า คุณมีเทคนิค ดังนั้นโปรแกรมแก้ไขแบบ WYSIWYG อาจเป็นตัวเลือกที่ดีที่สุดสำหรับคุณหรือไม่ก็ได้ คุณไม่จำเป็นต้อง (หรือแม้แต่ชอบ!) การนำทางเมนูแถบเครื่องมือและริบบอนเพื่อจัดรูปแบบข้อความของคุณ



แล้วถ้าอย่างนั้นคุณสามารถเพิ่มรูปแบบการจัดรูปแบบทั้งหมดของคุณลงในข้อความได้อย่างง่ายดายเป็นไวยากรณ์แบบอินไลน์ง่ายๆเพื่อให้ได้ข้อความที่มีรูปแบบครบถ้วน



คือการตอบสนองกรอบหรือไลบรารี

ในความเป็นจริงคุณทำได้ นั่นคือ Markdown และนั่นคือสิ่งที่บทแนะนำนี้เป็นข้อมูลเกี่ยวกับ



เมื่อมากขึ้นน้อยลง ...

ซอฟต์แวร์ประมวลผลคำถูกเขียนขึ้นเพื่อตอบสนองผู้ใช้และกรณีการใช้งานที่หลากหลายดังนั้นจึงจำเป็นต้องมีฟังก์ชันการทำงานทุกประเภท แต่เห็นได้ชัดว่ามีเพียงส่วนเล็ก ๆ ของฟังก์ชันที่น่าจะเกี่ยวข้องกับผู้ใช้แต่ละคน และสำหรับผู้ใช้ส่วนใหญ่ที่ต้องการเขียนเอกสาร (และไม่จำเป็นต้องออกแบบโบรชัวร์หรือโปสเตอร์ทางการตลาด) ส่วนย่อยที่มีขนาดเล็กมากจากหลาย ๆ ตัวเลือกที่มีอยู่นั้นมีความเกี่ยวข้อง

ในความเป็นจริง Microsoft ตระหนักอย่างชัดเจนเมื่อไม่กี่ปีก่อนเมื่อพวกเขาออกแบบอินเทอร์เฟซผู้ใช้ของ Microsoft Word ใหม่ให้เป็นกลุ่มการทำงานที่แตกต่างกันซึ่งเรียกว่า 'ริบบอน' สิ่งที่น่าสนใจคือผู้ใช้ส่วนใหญ่จะบอกคุณว่าพวกเขาพบว่าอินเทอร์เฟซใหม่มีความสับสนและนำทางยากกว่ารุ่นก่อน



เรียนรู้ markdown

อันที่จริงบางครั้งอาจมีน้อยลงเมื่อใช้งานง่ายและเพิ่มผลผลิต



... และเมื่อน้อยลง

คุณเป็นวิศวกรซอฟต์แวร์ไม่ใช่นักออกแบบกราฟิก คุณเพียงแค่ต้องการเขียนคู่มือหรือเอกสารทางเทคนิคหรือรายงานและดำเนินการกับมัน คุณจะมีความสุขมากและพอใจกับความสามารถในการจัดรูปแบบพื้นฐานบางอย่างเช่นส่วนหัวรายการสัญลักษณ์แสดงหัวข้อย่อยหรือลำดับเลขและบล็อกโค้ด และโอ้ใช่การจัดรูปแบบตัวอักษร (ตัวหนาตัวเอียง ฯลฯ ) ก็จะเป็นประโยชน์เช่นกัน เกี่ยวกับมัน. (และผู้ชายถ้าคุณทำได้แค่นั้น เรา มันจะยอดเยี่ยมจริงๆ!)

เข้าสู่ Markdown



Markdown คืออะไร?

จอห์นกรูเบอร์ (ด้วยผลงานมากมายจากกูรูด้านเทคนิคและนักเคลื่อนไหวทางอินเทอร์เน็ต Aaron Swartz ) สร้างภาษา Markdown ในปี 2004 ด้วย เป้าหมาย ในการทำให้ผู้คน“ เขียนโดยใช้รูปแบบข้อความธรรมดาที่อ่านง่ายเขียนง่ายและสามารถเลือกที่จะแปลงเป็น XHTML (หรือ HTML) ที่ถูกต้องตามโครงสร้าง”



วิธีเรียกใช้แอปพลิเคชัน angularjs

Markdown ได้รับการออกแบบมาให้อ่านได้ตามที่เป็นอยู่โดยไม่ดูเหมือนว่ามีการมาร์กอัปด้วยแท็กหรือคำแนะนำในการจัดรูปแบบ (ซึ่งแตกต่างจากข้อความที่จัดรูปแบบด้วยภาษามาร์กอัปเช่น RTF หรือ HTML ซึ่งสามารถเขียนได้ยากและอ่านยากในรูปแบบดิบ ).

Markdown ช่วยให้คุณเขียนโดยใช้รูปแบบข้อความธรรมดาที่อ่านง่ายและเขียนง่ายซึ่งสามารถแปลงเป็น HTML ที่ถูกต้องตามโครงสร้างได้ ดังนั้นเพื่อให้แม่นยำทั้งหมด Markdown เป็นสองสิ่งจริงๆ :



  1. ไวยากรณ์การจัดรูปแบบข้อความธรรมดา
  2. เครื่องมือซอฟต์แวร์ (เวอร์ชันแรกที่เขียนด้วย Perl) ที่แปลงการจัดรูปแบบข้อความธรรมดาเป็น HTML

Markdown ประกอบด้วยรูปแบบไวยากรณ์ที่เรียบง่ายใช้งานง่ายและใช้งานง่ายจำนวนหนึ่ง โดยเฉพาะอย่างยิ่งสำหรับคุณในฐานะวิศวกรซอฟต์แวร์ผู้ซึ่งไม่ได้ถูกเลื่อนออกไปโดยจำเป็นต้องเรียนรู้และใช้รูปแบบไวยากรณ์พื้นฐานเหล่านี้ Markdown สามารถเป็นเส้นทางที่มีการต่อต้านน้อยที่สุดระหว่างสิ่งที่คุณต้องการเขียนและการเขียน

วิธีสร้าง Discord bot ลงช่องเดียวเท่านั้น

อนุสัญญาทางไวยากรณ์ markdown

เรียนรู้ Markdown: เริ่มต้นใช้งาน

Markdown เป็นเรื่องง่ายที่จะเรียนรู้ ง่ายสุด ๆ คุณสามารถเรียนรู้พื้นฐานได้ในห้านาทีและจะกลายเป็นลักษณะที่สองอย่างรวดเร็ว และ - เช่นเดียวกับความสัมพันธ์ระหว่างตัวประมวลผลล่วงหน้า CSS และ CSS คุณสามารถใช้น้อยหรือมากเท่าที่คุณต้องการ

หากคุณเคยชินกับรูปแบบการเขียนข้อความธรรมดา ๆ คุณอาจคุ้นเคยกับรูปแบบการมาร์กดาวน์เช่นตัวเลขหรือขีดกลางที่จุดเริ่มต้นของประโยคเพื่อสร้างรายการดอกจันรอบ ๆ คำเพื่อเน้นและอื่น ๆ บน. ตัวอย่างเช่นหากคุณต้องการแสดงบางสิ่งที่เป็นตัวเอียงให้ห่อด้วยเครื่องหมายดอกจันเช่น *this* (ตรงข้ามกับไวยากรณ์ HTML แบบ clunkier เช่น this)

ในทำนองเดียวกันคุณสามารถระบุหัวเรื่อง H1 ได้โดยเพิ่มคำนำหน้า ‘#’ ในบรรทัดของคุณ (เช่น # Section Heading แทนที่จะเป็น # Initiating Plugins

Initiate pluginName บนคอนเทนเนอร์ของคุณโดยใช้ jQuery ดังนี้:

เริ่มต้น 'pluginName' บนคอนเทนเนอร์ของคุณโดยใช้ jQuery ดังนี้:
$(function() { $('#container').pluginName(); });
`$ (function () {$ ('# container'). pluginName ();});'

เมื่อใช้ ID คอนเทนเนอร์ของเราเราสามารถเริ่มต้น pluginName ด้วยวิธี jQuery .pluginName()

* ใช้ ID คอนเทนเนอร์ของเราเราสามารถเริ่มต้น 'pluginName' ด้วยเมธอด jQuery '.pluginName ()'. *

สำหรับความช่วยเหลือเพิ่มเติมในการเริ่มต้นมีบทแนะนำ Markdown ออนไลน์มากมายที่จะช่วยให้คุณได้รับความรวดเร็วรวมถึงไฟล์ ภาพรวม Markdown โดย John Gruber (ผู้สร้าง Markdown) และออนไลน์ บทแนะนำ Markdown .

Markdown Parsers และเครื่องมือ

เมื่อคุณเขียนบทความใน Markdown แล้วคุณจะต้องมีแอปเพื่อแยกวิเคราะห์ไวยากรณ์เป็น HTML มีไม่กี่คนที่ยอดเยี่ยมนั่นคือ ฟรี รวมถึง:

  • StackEdit - ตัวแก้ไข Markdown บนเบราว์เซอร์ที่มีตัวเลือกการซิงค์สองสามตัวพร้อมบริการยอดนิยมเช่น Google Drive และ Dropbox
  • โปรแกรมแก้ไข Kramdown ออนไลน์ - โปรแกรมแก้ไข Markdown บนเบราว์เซอร์อื่นที่มีอินเทอร์เฟซที่เรียบง่ายมาก
  • หมู - นักเขียน Markdown ที่ใช้ Mac ที่ดีที่สุดที่ฉันเจอเป็นตัวเลือกที่ดีกว่าสำหรับนักพัฒนา คุณสมบัติมากมายและฟรี (ขณะอยู่ในรุ่นเบต้า) [นี่คือสิ่งที่ฉันเคยเขียนบทความนี้]
  • MarkdownPad - ตัวแก้ไข Markdown ที่ยอดเยี่ยมสำหรับ Windows
  • ตำรา - โปรแกรมแก้ไขข้ามแพลตฟอร์ม (Mac และ Windows) ที่ดี ส่งออกไปยังรูปแบบต่างๆเช่น PDF, .doc และ ePub

แพลตฟอร์มหลักบางแพลตฟอร์มได้นำ Markdown มาใช้ (หรืออย่างน้อยก็อนุญาต) ใช้ในโปรแกรมแก้ไขสำหรับผู้ที่ต้องการใช้งาน สำหรับผู้อื่นเช่น WordPress, Evernote และ Google Docs การสนับสนุนแบบเนทีฟ (ในขณะที่เขียนบทความนี้) ยังไม่ได้รับการรวมเข้าด้วยกัน แต่บุคคลที่สามได้นำโซลูชันแบบกำหนดเองมาใช้ ซึ่งรวมถึง:

  • แพลตฟอร์มบล็อกใหม่ยอดนิยม ผี เพื่อเพิ่มประสิทธิภาพการเขียนออนไลน์ใช้ Markdown สำหรับตัวแก้ไขเนื้อหา
  • สำหรับ WordPress ตอนนี้ปลั๊กอิน Jetpack รองรับ Markdown อย่างเป็นทางการแล้วซึ่งคุณสามารถเปิดใช้งานได้ภายใต้ การตั้งค่า> การสนทนา หากคุณใช้ปลั๊กอิน หรือคุณสามารถใช้ปลั๊กอินเช่น WP-Markdown ซึ่งจะแปลงเนื้อหา post markdown ของคุณเป็น HTML และกลับไปที่ Markdown เมื่อคุณต้องการแก้ไข
  • สำหรับ Evernote แอป Markdown บางตัวเช่นโปรแกรมแก้ไขออนไลน์ ทำเครื่องหมายได้ หรือตัวแก้ไข Mac Byword อนุญาตให้ส่งออกและเผยแพร่โดยตรงไปยังบันทึกย่อ หรือหากคุณต้องการใช้เว็บแอป Evernote โดยตรงคุณสามารถใช้ส่วนขยายของเบราว์เซอร์ที่เรียกว่า Markdown ที่นี่ ซึ่งจะแปลงบันทึกย่อที่เลือกที่เขียนลงใน Markdown เป็นข้อความที่จัดรูปแบบด้วยการคลิกปุ่มแถบเครื่องมือ
  • Google เอกสารยังไม่รองรับ Markdown แต่มีผู้แก้ไขบางส่วน (เช่น StackEdit ) จะส่งออก / ซิงค์โดยตรงกับไดรฟ์

ข้อเสีย

แน่นอนว่าด้วยความเรียบง่ายที่ยอดเยี่ยมทำให้เกิดข้อ จำกัด ดังที่ฉันได้อธิบายไปแล้ว Markdown ไม่ได้เขียนขึ้นสำหรับงานประมวลผลคำที่ซับซ้อนซึ่งต้องใช้คุณสมบัติการจัดรูปแบบขั้นสูง หากนั่นคือสิ่งที่คุณต้องการ Markdown ไม่ใช่เครื่องมือที่เหมาะสม

แต่สำหรับนักพัฒนาที่ต้องเขียนคู่มือผู้ใช้หรือเอกสารทางเทคนิคหรือรายงานทางเทคนิค Markdown ให้ความสมดุลที่ใกล้เคียงกันระหว่างความเรียบง่ายและคุณสมบัติที่คุณต้องการ

บริษัท c, บริษัท s, และ llcs สามารถ ________ จัดตั้งได้

บางทีข้อเสียเปรียบที่ใหญ่ที่สุด - โดยเฉพาะอย่างยิ่งสำหรับวิศวกรของเราที่เป็นผู้ควบคุมการเปลี่ยนแปลง - ไม่สามารถทำได้ ทำงานร่วมกัน ใน Markdown และเพื่อติดตามการเปลี่ยนแปลง (ข้อยกเว้นที่น่าสังเกตอย่างหนึ่งของสิ่งนี้คือไฟล์ StackEdit ปลั๊กอินสำหรับ Google เอกสาร) และแน่นอนว่าด้วยความพยายามเพียงเล็กน้อยเราสามารถทำงานร่วมกันในเอกสาร Markdown ผ่านที่เก็บ git และด้วยเหตุนี้จึงได้รับการติดตามการเปลี่ยนแปลงและการทำงานร่วมกันทั้งหมดที่โดยทั่วไปต้องการ

สรุป

ดังนั้นการเรียนรู้ Markdown สำหรับทุกคน? ไม่แน่นอน ไม่เคยมีเครื่องมือใด

แต่ถ้าคุณเป็นวิศวกรซอฟต์แวร์อาจเป็นเครื่องมือเขียนที่คุณกำลังมองหาได้เป็นอย่างดี ดังนั้นหากคุณยังไม่ได้ลองคุณควรลองใช้ดู

กระบวนการออกแบบ: วัตถุประสงค์หรืออัตวิสัย?

กระบวนการออกแบบ

กระบวนการออกแบบ: วัตถุประสงค์หรืออัตวิสัย?
วิธีเลือก Front-End Framework ที่ดีที่สุด

วิธีเลือก Front-End Framework ที่ดีที่สุด

ส่วนหน้าของเว็บ