แปลงฟรี

README.md เครื่องสร้างเทมเพลต

สร้างเทมเพลต README.md ระดับมืออาชีพสำหรับโปรเจ็กต์ GitHub ของคุณ ปรับแต่งส่วน ป้าย และการจัดรูปแบบในไม่กี่วินาที

การตั้งค่า
รวมป้าย
รวมส่วนต่างๆ
เทคสแต็ค
สร้าง README.md
# my-project

> A short description of your project.

[![npm version](https://img.shields.io/npm/v/my-project.svg)](https://www.npmjs.com/package/my-project)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Build Status](https://img.shields.io/github/actions/workflow/status/username/repo/ci.yml)](https://github.com/username/repo/actions)

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Features

- Feature 1
- Feature 2
- Feature 3

## Installation

```bash
npm install my-project
```

Or using yarn:

```bash
yarn add my-project
```

## Usage

```javascript
const myProject = require('my-project');

// Example usage
// my-project.doSomething();
```

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct.

## License

MIT © [Author Name](https://github.com/username)

See [LICENSE](LICENSE) for more information.

---

Made with by [Author Name](https://github.com/username)

เกี่ยวกับเครื่องมือนี้

สร้างไฟล์ README.md ระดับมืออาชีพสำหรับที่เก็บ GitHub ของคุณ กรอกรายละเอียดโปรเจ็กต์ การติดตั้ง การใช้งาน การอ้างอิง API แนวทางการสนับสนุน และใบอนุญาตในส่วนต่างๆ เครื่องมือนี้สร้าง Markdown ที่มีโครงสร้างดีตามมาตรฐานชุมชน GitHub และแนวปฏิบัติที่ดีที่สุดสำหรับเอกสารโอเพ่นซอร์ส

วิธีใช้งาน

  1. ป้อนชื่อโครงการ คำอธิบาย และคุณลักษณะหลักของคุณ
  2. กรอกคำแนะนำในการติดตั้งและตัวอย่างการใช้งาน
  3. เพิ่มส่วนเสริม: เอกสาร API, แนวทางการสนับสนุน, ใบอนุญาต
  4. คัดลอก Markdown ที่สร้างขึ้นและบันทึกเป็น README.md ในพื้นที่เก็บข้อมูลของคุณ

คำถามที่พบบ่อย

README ที่ดีควรมีส่วนใดบ้าง
สิ่งสำคัญ: ชื่อ/คำอธิบายโปรเจ็กต์ การติดตั้ง ตัวอย่างการใช้งาน แนะนำ: คุณลักษณะ, การอ้างอิง API, แนวทางการสนับสนุน, ใบอนุญาต, ป้าย ตัวเลือกเสริม: ภาพหน้าจอ บันทึกการเปลี่ยนแปลง คำถามที่พบบ่อย การรับทราบ
ไวยากรณ์ Markdown ใดที่ทำงานบน GitHub
GitHub Flavoured Markdown (GFM) รองรับตาราง Markdown plus มาตรฐาน รายการงาน (- [ ]) บล็อกโค้ดที่เน้นไวยากรณ์ (``` python) URL ที่ลิงก์อัตโนมัติ ขีดทับ (~~ text~~) และรหัสย่อของอิโมจิ (:rocket:)
README ควรนานแค่ไหน?
ยาวพอที่จะช่วยให้ผู้ใช้เริ่มต้นได้ สั้นพอที่จะอ่านได้ README แบบโอเพ่นซอร์สที่ประสบความสำเร็จมากที่สุดคือ 200-500 บรรทัด ใช้สารบัญสำหรับเอกสารที่ยาวขึ้น และลิงก์ไปยังเอกสารแยกกันเพื่อดูคำแนะนำโดยละเอียด
ฉันควรรวมตราสัญลักษณ์หรือไม่?
ป้ายสถานะ (สถานะบิลด์, เวอร์ชัน npm, ใบอนุญาต) ให้ตัวบ่งชี้สถานภาพโครงการอย่างรวดเร็ว เป็นมาตรฐานสำหรับแพ็คเกจโอเพ่นซอร์ส ใช้ shields.io เพื่อการจัดรูปแบบป้ายที่สอดคล้องกัน