"มาร์กดาวน์" คืออะไร?
เนื่องจากคุณและฉันเป็นโปรแกรมเมอร์ เราจะไปที่ Google ทันทีและเปิด ลิงก์ Wiki แรก ซึ่งระบุว่า: Markdown เป็นภาษามาร์กอัปขนาดเล็กที่สร้างขึ้นโดยมีเป้าหมายในการเขียนข้อความที่อ่านง่ายและแก้ไขได้ง่ายที่สุด แต่เหมาะสำหรับ การแปลงเป็นภาษาสำหรับสิ่งพิมพ์ขั้นสูง (HTML , Rich Text และอื่น ๆ ) พูดตามตรงว่าฉันไม่มีอะไรจะเสริมมากนัก ฉันคิดว่านี่เป็นคำอธิบายที่เกือบจะสมบูรณ์แบบทำไมเราถึงต้องการ "Markdown" นี้?
พูดตามตรง จริงๆ แล้วมันก็ไม่ได้แย่เลยถ้าไม่มีมัน :D แต่อย่าลืมเป้าหมายของเรา: การเขียนเทมเพลตโครงการที่มีความสามารถซึ่งมีการบูรณาการอย่างต่อเนื่องและมีสถิติการครอบคลุมโค้ดในทรัพยากร Codecov ทำไมฉันถึงพูดถึงเรื่องนี้? ยิ่งไปกว่านั้น Markdown จะอนุญาตให้เรานำข้อมูลจากแหล่งข้อมูลเหล่านี้และจัดเตรียมข้อมูลเอง หรือป้ายที่จะเปลี่ยนเส้นทางเราไปที่ที่เราต้องการรับข้อมูลนี้ การมีทุกอย่างไว้ใน "ชื่อ" หน้าเดียวจะสะดวก แทนที่จะกระจัดกระจายไปตามที่ต่างๆ ใช่ไหมมันใช้ที่ไหน?
ใครก็ตามที่เคยอัปโหลดโครงการใด ๆ ของตนไปยัง GitHub อย่างน้อยหนึ่งครั้งจะรู้ว่า GitHub ต้องการเชิญคุณอย่างต่อเนื่องให้สร้างไฟล์ README:
จะทำงานกับมันอย่างไร?
อันดับแรก ดังที่คุณอาจสังเกตเห็นแล้ว เราสามารถเพิ่มมันลงใน GitHub ได้โดยตรง และมันจะใช้งานได้! แต่เราไม่จำเป็นต้องเพิ่มมันลงในโปรเจ็กต์เดียวเสมอไป หรือตัวอย่างเช่น เราต้องการคิดเพิ่มเติมเกี่ยวกับวิธีการสร้างมันขึ้นมา และที่นี่ GitHub ก็ไม่เหมาะกับเราอีกต่อไป และโดยทั่วไป เราสามารถสร้างไฟล์ Markdown ไม่เพียงแต่เพื่อจุดประสงค์ในการส่งไฟล์เหล่านั้นไปยัง GitHub เท่านั้น ประการที่สอง เราสามารถสร้างมันได้โดยตรงผ่าน IDEA ซึ่งเป็นสิ่งที่เราจะทำอย่างแน่นอน แต่ไม่ใช่ในทันที ด้วยเหตุผลที่ว่า ทำไมเราจึงต้องมีสภาพแวดล้อมการพัฒนาที่ทรงพลังเพื่อเขียนไฟล์ขนาดเล็กเพียงไฟล์เดียว ที่นี่ฉันขอแนะนำให้เรียกดูแค็ตตาล็อกของโปรแกรมแก้ไขไฟล์ Markdown ที่ง่ายและไม่ง่ายนัก สำหรับตัวฉันเอง ฉันเลือกHaroopadมันเรียบง่าย เข้าถึงได้ นำเสนอสิ่งที่คุณเขียนได้ทันที (IDEA ก็ทำเช่นกัน) และมีคำใบ้ทางไวยากรณ์ หน้าต่างตัวแก้ไขมีลักษณะดังนี้:
-
มาเขียนชื่อ - ชื่อโครงการของเรากัน
ส่วนหัวหลักและใหญ่ที่สุดถูกสร้างขึ้นโดยใช้ตัวดำเนินการแฮช " # " จากนั้นจึงเขียนชื่อเรื่อง ในกรณีของเรา:
# ForJavaRushPublication
-
จากนั้นเราจะเขียนชื่อที่เล็กลงเล็กน้อย และเราจะเขียนว่า "ข้อมูลโครงการ" ส่วนหัวที่เล็กกว่าจะนำหน้าด้วย more " # ":
## Information
จากนั้นเราจะเขียนข้อมูลเกี่ยวกับโครงการ
-
มาแทรกลิงก์ไปยังบทความของเรา ซึ่งทำได้ง่ายมาก และหากคุณใช้ Haroopad เพียงพิมพ์สูตรโกง จากนั้นเทมเพลตก็จะถูกแทรกเข้าไปเอง ไวยากรณ์คือ: " [text](url) ";
-
มาใส่ป้ายกันเถอะ มาดูที่นี่กันดีกว่า
ขั้นแรกให้จัดเป็นโต๊ะเพื่อความสวยงาม จะมี 2 คอลัมน์ และ 2 คอลัมน์ ไวยากรณ์จะมีลักษณะดังนี้:
และผลลัพธ์จะเป็นดังนี้:
ต่อไป เราจะใส่ไฮเปอร์ลิงก์ไปที่ป้ายสถานะของเรา แต่เราจะหาได้จากที่ไหน? ในบทความก่อนหน้านี้ ฉันแสดงให้เห็นว่าจะรับ Codecov ได้ที่ไหน แต่ฉันไม่ได้บอกว่าควรซื้ออันไหน เนื่องจากเรามีไฟล์ Markdown เราจึงต้องมี Markdown Badge ด้วย:
เพียงคัดลอกและวางลงในคอลัมน์ใน Markdown ของเรา แต่อย่าลืมว่า Codecov ปรากฏในสาขา JaCoCo แต่ไม่ใช่ในสาขาหลัก ดังนั้นคุณจะต้องแก้ไขด้วยตนเอง Travis CI Badge อยู่ตรงข้ามกับชื่อโปรเจ็กต์ โดยมีบันทึกการสร้างคือ:
เราเลือกตรา จากนั้นหน้าต่างการตั้งค่าจะปรากฏขึ้น:
เราเลือก Markdown และสาขาที่คุณต้องการอย่างแน่นอน ฉันจะสร้าง README.md สำหรับสองสาขา และจะแตกต่างออกไปเล็กน้อย เนื่องจากฉันยังไม่ได้ติดตั้ง Codecov ในสาขาหลัก
-
มาเขียนข้อมูลเกี่ยวกับวิธีการนำเข้าหรือโคลนโครงการนี้กัน ฉันจะไม่อธิบายวิธีการทำเช่นนี้ แต่คุณสามารถอ่านได้ใน README.md ของฉัน เราจะเขียนเกี่ยวกับเทคโนโลยีที่เราใช้ในโครงการของเราโดยวางลิงก์ไปยังเทคโนโลยีเหล่านั้น อย่างไรก็ตาม นี่เป็นโครงการด้านการศึกษา เรามาเขียนข้อมูลการติดต่อกันดีกว่า
-
Markdown ของเราพร้อมแล้ว สิ่งที่เราต้องทำคือเพิ่มมันเข้าไปในโปรเจ็กต์ของเรา เท่านี้ก็เสร็จเรียบร้อย แต่ไม่ใช่ทั้งหมดในคราวเดียว! มาเปิด IDEA ของเรากันดีกว่า และในปลั๊กอินเราจะตรวจสอบว่าคุณมีการสนับสนุน Markdown:
ฉันมี Ultimate IDEA ดังนั้นฉันจึงมีทุกอย่าง ปลั๊กอินของคุณอาจไม่ได้ติดตั้งตามค่าเริ่มต้น แต่เมื่อคุณสร้างไฟล์ที่มีนามสกุล md คุณควรได้รับแจ้งให้ดาวน์โหลด ดาวน์โหลดและรีสตาร์ท IDEA ของคุณ
-
หลังจากนำเข้า Markdown ที่เราเขียนแล้ว ให้เปิดผ่าน IDEA และแก้ไขหากจำเป็น นี่คือลักษณะที่ปรากฏผ่าน IDEA:
เราดัน. จากนั้นเราจะเห็นว่าเมื่อเปิดโครงการข้อมูลเกี่ยวกับโครงการจะถูกโหลดทันทีนี่คือ README.md ของเรา:
ตอนนี้ เมื่อเราคลิกที่ป้าย เราสามารถข้ามไปที่ชุดประกอบโครงการได้ทันที และดูว่าเรามีอะไรบ้างและทำอย่างไร
-
ฉันจะทำเช่นเดียวกันกับสาขา JaCoCo เพื่อสาธิต Codecov Badge เนื่องจากเรายังไม่มี README.md อยู่ในนั้น ด้วยเหตุนี้ ตอนนี้เรามีป้ายสถานะสองป้าย:
Codecov แสดงเปอร์เซ็นต์ของการครอบคลุมโค้ด และยังสามารถเปลี่ยนเส้นทางเราไปยังหน้า Codecov และแสดงรายงานการครอบคลุมโค้ดโดยละเอียด
- สิ่งที่ Wikiบอกเราเกี่ยวกับ Markdown;
- ไดเรกทอรี บรรณาธิการ Markdown ;
- Haroopadที่ฉันแนะนำ;
- เกี่ยวกับ Markdown บน เว็บไซต์ JetBrains
- Markdown Navigatorบน JetBrains เดียวกัน
- ป้ายและทุกสิ่งเกี่ยวกับพวกเขา ที่นี่คุณสามารถเลือกรูปแบบของเหรียญตราและปรับแต่งได้ด้วยตัวคุณเอง
- จะอัพเกรดโครงการโอเพ่นซอร์สของคุณได้อย่างไร? บทความ นี้จะตอบด้วย;
- บทความก่อนหน้านี้
- เราดูว่า CI คืออะไร มีไว้เพื่ออะไร และใช้งานอย่างไรในบทความแรกเกี่ยวกับContinuous Integration
- เราเล่นกับ CC และทำความเข้าใจว่ามันคืออะไรและทำไมจึงจำเป็นในบทความที่สองเกี่ยวกับCode Coverage
- และในบทความนี้เราได้พิจารณาว่า Markdown คืออะไร เหตุใดจึงมีความจำเป็น และจะใช้อย่างไรให้มีประสิทธิภาพ
GO TO FULL VERSION