vimdown เป็นเครื่องมือที่สกปรกการแปลง .vimrc และไฟล์สคริปต์ .vim เพื่อ markdown
ติดตั้ง
วิธีที่ง่ายที่สุดในการติดตั้งคือการใช้จุด
PIP ติดตั้ง vimdown
หรือคุณสามารถเลือกที่จะติดตั้งดาวน์โหลดได้จาก GitHub
ภาพรวม
Vimdown แปลงไฟล์ .vim ลงในเอกสาร markdown
Vimdown เกิดออกมาจากคันที่จะทำให้ .vimrc ของฉันดูดีเป็นไฟล์ README.mkd สำหรับพื้นที่เก็บข้อมูล GitHub ของฉันที่มีไดเรกทอรี .vim ของฉัน
README นี้ถูกเขียนเป็นไฟล์เสียงเรียกเข้าและแสดงให้ markdown กับ vimdown
Vimdown เป็นตัวแยกวิเคราะห์ที่ง่ายมาก ทั้งหมดมันไม่สามารถแยกไฟล์ลงในบล็อกที่เป็นกลุ่มของข้อความที่แสดงความคิดเห็นอย่างใดอย่างหนึ่งต่อเนื่องกันหรือติดกันแสดงความคิดเห็นที่ไม่ บล็อกแสดงความคิดเห็นจะถูกปลดออกจากเครื่องหมายแสดงความคิดเห็นของพวกเขา '"' จากจุดเริ่มต้นของเส้นและการพิจารณาให้เป็นในไวยากรณ์ markdown. บล็อกไม่ได้รับการพิจารณาความคิดเห็นบล็อกรหัสและจะถูกแทรกลงในเอกสาร markdown ผลเป็น codeblocks เป็นกลุ่มอย่างชัดเจน. เท่านั้น เส้นที่มีเครื่องหมายแสดงความคิดเห็น '"' เป็นอักขระตัวแรกหรือครั้งที่สองของสายได้รับการพิจารณาความคิดเห็น ถ้าเครื่องหมายแสดงความคิดเห็นเริ่มต้นต่อมาในสายก็จะได้รับการพิจารณารหัสด้วยกับความคิดเห็นในการป้องกันรหัส
การใช้งาน
Vimdown ได้สร้างขึ้นในความช่วยเหลือการส่งออก
> vimdown --help
ขั้นพื้นฐาน
เพียงแค่ให้คำสั่ง vimdown ไฟล์หรือไฟล์ที่จะดำเนินการและจะพิมพ์ออกผลไปยัง stdout:
> vimdown INFILE> OUTFILE
คุณสามารถระบุไฟล์ที่ส่งออก:
> vimdown -o OUTFILE INFILE
การใช้ไฟล์ข้อมูลหลาย
> vimdown INFILE infile2 infile3 -o OUTFILE
ขั้นสูง
Markdown2 บล็อกรหัส
คุณสามารถมีบล็อก markdown2 รหัสสไตล์ด้วย -c:
> vimdown -c -o OUTFILE INFILE
ที่จะสร้างบล็อกรหัสใน markdown ในรูปแบบของ:
& nbsp; ::: เป็นกลุ่ม
& nbsp; รหัสที่นี่
Render เป็น HTML
ถ้าคุณได้ติดตั้ง markdown2 คุณสามารถขอ vimdown จะทำให้ markdown เป็น HTML เพื่อให้คุณมีตัวเลือก -t
นี้จะทำให้เอกสาร markdown ขั้นพื้นฐานเป็น HTML เป็น OUTFILE
> vimdown -t -o OUTFILE INFILE
นี้จะทำให้เอกสาร markdown กับ codeblocks markdown2 เป็น HTML เป็น OUTFILE
> vimdown -c -t -o OUTFILE INFILE
Pygments รูปแบบ
หากคุณมีทั้ง Markdown2 และ Pygments ติดตั้งคุณสามารถมี vimdown ทำให้ออกเป็นเอกสาร HTML ที่มีมาร์กอัปรหัสสไตล์สำหรับ Pygments ใช้ตัวเลือก -p:
> vimdown -p -o OUTFILE INFILE
ตัวอย่าง
หากต้องการดูการใช้งานจริงในโลกของ vimdown, เช็คเอา README สำหรับ Viming กับ Buttars โครงการ
ทุกสิ่งที่คุณเคยเห็นในเอกสารเพื่อให้ห่างไกลเป็นตัวอย่างของวิธี vimdown แสดงผลความคิดเห็นในไฟล์ที่เป็นกลุ่ม
บล็อกแสดงความคิดเห็นต้องมี "เครื่องหมายแสดงความคิดเห็นในตำแหน่งที่ตัวอักษรตัวแรกหรือครั้งที่สองของสาย
บล็อกความคิดเห็น:
"# ความคิดเห็น
"_comment_
"แสดงความคิดเห็น
จะทำให้เป็น:
คิดเห็น
คิดเห็น
คิดเห็น
บล็อกแสดงความคิดเห็นอีกความคิดเห็นจะเริ่มในพื้นที่พิเศษ:
& nbsp; "[กระทู้] (http://google.com)
& nbsp; "แสดงความคิดเห็น
& nbsp; "__comment__
แสดงผลเป็น:
คิดเห็น
คิดเห็น
คิดเห็น
นี้จะได้รับการพิจารณาการป้องกันรหัส:
& nbsp; "[กระทู้] (http://google.com)
& nbsp; "# ความคิดเห็น
& nbsp; "แสดงความคิดเห็น
กลายเป็น:
& nbsp; "[กระทู้] (http://google.com)
& nbsp; "# ความคิดเห็น
& nbsp; "แสดงความคิดเห็น
ตัวอย่างต่อไปนี้เป็นวิธีการที่จะทำให้บล็อกรหัส
ถ้าตัวแปร <10
& nbsp; ให้ g: ตัวแปร = 0
endif
การป้องกันรหัสที่มีความคิดเห็น
ถ้า filereadable (TSTR)
& nbsp; "ให้แน่ใจว่าตูดใหญ่ของเรา BSD ไฟล์แท็ก
& nbsp; "ถูกนำมาใช้ใน subdirs ได้เป็นอย่างดี
& nbsp; แท็กชุด + = TSTR "ความคิดเห็นที่ท้ายบรรทัด
endif
ต้องการ
- หลาม
ความคิดเห็นที่ไม่พบ