markdown zen

มาร์กดาวน์เซน

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

สารบัญ

• เริ่มต้นใช้งาน
  • ข้อกำหนดเบื้องต้น
  • การติดตั้ง
• การใช้งาน
• คุณสมบัติ
• ทำงานด้วยนักเทียบท่า
• มีส่วนร่วม
• ใบอนุญาต

เริ่มต้นใช้งาน

ข้อกำหนดเบื้องต้น

ก่อนที่คุณจะเริ่มต้น ตรวจสอบให้แน่ใจว่าคุณได้ติดตั้งซอฟต์แวร์ต่อไปนี้บนคอมพิวเตอร์ของคุณ:

• โหนด js
• npm (ตัวจัดการแพ็กเกจโหนด)

การติดตั้ง

1. โคลนพื้นที่เก็บข้อมูล :

   เปิดเทอร์มินัล/พรอมต์คำสั่งของคุณแล้วนำทางไปยังตำแหน่งที่คุณต้องการจัดเก็บโปรเจ็กต์ จากนั้นรันคำสั่งต่อไปนี้:

git clone https://github.com/daniel752/markdown-zen.git

นี่จะเป็นการดาวน์โหลดไฟล์โครงการไปยังคอมพิวเตอร์ของคุณ

2. นำทางไปยังโฟลเดอร์โครงการ :

ใช้คำสั่ง cd เพื่อเปลี่ยนไดเร็กทอรีการทำงานของคุณเป็นโฟลเดอร์โปรเจ็กต์ที่โคลน:

cd markdown-zen

3. ติดตั้งการพึ่งพา :

ภายในโฟลเดอร์โปรเจ็กต์ ให้ติดตั้งการขึ้นต่อกันที่จำเป็นสำหรับทั้งเซิร์ฟเวอร์และไคลเอนต์โดยใช้คำสั่งเดียว:

npm run setup-project

สิ่งนี้จะติดตั้งแพ็คเกจที่จำเป็นสำหรับเซิร์ฟเวอร์และส่วนประกอบไคลเอนต์ของแอป

การใช้งาน

1. เริ่มแอปพลิเคชัน :

หากต้องการเปิดแอปพลิเคชัน ให้รันคำสั่งต่อไปนี้ในโฟลเดอร์รูท (markdown-zen/):

npm run dev

คำสั่งนี้เริ่มต้นทั้งเซิร์ฟเวอร์และไคลเอนต์พร้อมกัน เพื่อให้คุณสามารถเข้าถึงแอพได้จากเบราว์เซอร์ของคุณ

2. เข้าถึงแอพ :

เปิดเว็บเบราว์เซอร์ของคุณแล้วไปที่ http://localhost:5173 ที่นี่คุณจะพบแอป MarkdownZen

3. การสร้างและการจัดการ Markdowns :

• เข้าสู่ระบบหรือสร้างบัญชี
• เริ่มสร้างและจัดการเอกสารมาร์กดาวน์ของคุณได้อย่างง่ายดาย

คุณสมบัติ

• สร้าง แก้ไข และจัดการเอกสารมาร์กดาวน์ได้อย่างง่ายดาย
• การแสดงตัวอย่างมาร์กดาวน์แบบเรียลไทม์ขณะแก้ไข
• จัดระเบียบมาร์กดาวน์โดยใช้หมวดหมู่และแท็ก
• ระบบการรับรองความถูกต้องและการอนุญาตที่ปลอดภัย
• -

ทำงานด้วยนักเทียบท่า

คุณยังสามารถเรียกใช้ MarkdownZen โดยใช้ Docker ได้ ทำตามขั้นตอนเหล่านี้:

1. ดึงรูปภาพนักเทียบท่า :

   ดึงอิมเมจ MarkdownZen Docker จาก Docker Hub:

   docker pull daniel752/markdown-zen:v1.0.0
   

2. เรียกใช้คอนเทนเนอร์ :

   เริ่มคอนเทนเนอร์ MarkdownZen:

   docker run -d daniel752/markdown-zen:v1.0.0
   
   

• -d: เรียกใช้คอนเทนเนอร์ในโหมดเดี่ยว (ในพื้นหลัง)
• คอนเทนเนอร์จะรันพอร์ต 8000 ภายในและ 5173 ภายนอก

มีส่วนร่วม

เรายินดีรับการสนับสนุนจากชุมชน! เพื่อสนับสนุน MarkdownZen ให้ทำตามขั้นตอนเหล่านี้:

1. แยกพื้นที่เก็บข้อมูล :

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

2. โคลนส้อมของคุณ :

โคลนพื้นที่เก็บข้อมูลแบบแยกของคุณไปยังเครื่องท้องถิ่นของคุณ:

git clone https://github.com/your-username/markdown-zen.git

3. สร้างสาขาใหม่ :

เปลี่ยนเป็นไดเร็กทอรีโครงการ:

cd markdown-zen

สร้างสาขาใหม่สำหรับคุณสมบัติของคุณ:

git checkout -b feature/my-new-feature

4. ทำการเปลี่ยนแปลง :

ทำการเปลี่ยนแปลงที่จำเป็นและดำเนินการ:

git commit -m 'Add some feature'

5. ผลักดันการเปลี่ยนแปลงของคุณ :

พุชการเปลี่ยนแปลงของคุณไปยังที่เก็บแบบแยกส่วนของคุณ:

git push origin feature/my-new-feature

6. ส่งคำขอดึง :

เยี่ยมชมพื้นที่เก็บข้อมูลดั้งเดิมบน GitHub แล้วคลิกปุ่ม "คำขอดึงใหม่" เพื่อส่งการเปลี่ยนแปลงเพื่อรับการตรวจสอบ

ใบอนุญาต

โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT ดูไฟล์ใบอนุญาตสำหรับรายละเอียด