UnifieReadme

UnifieReadme: A README generator that standardizes project documentation, ensuring clarity and consistency across your codebase.

English | 中文

---

Table of Contents

• Background
• Features
• Installation
• Usage
  • Command Line Usage
• API
  • I/O Functions
  • Formatting Functions
• Documentation
• Authors
• Contributing
• License

---

Background

Creating and maintaining consistent README files is essential for collaborative projects. UnifieReadme simplifies this process by offering a standardized README template and automated text-to-markdown conversion, ensuring all your project documentation stays uniform and easy to read.

---

Features

• Standardized Templates: Provides a consistent structure for README files across projects.
• Markdown Conversion: Converts plain text to markdown format.
• Customizable: Easily modify templates to suit project-specific requirements.

---

Installation

This project requires Node.js and npm. Ensure these are installed before proceeding.

$ npm install --global unifie-readme

---

Usage

UnifieReadme offers tools to convert plain text to markdown format and generate standardized README templates. Be sure your text files follow markdown syntax to avoid conversion errors.

const fs = require('fs');
const unifieReadme = require('unifie-readme');

const txtFile = fs.readFileSync('file.txt', 'utf-8');
const markdown = unifieReadme.convertToMarkdown(txtFile);

fs.writeFileSync('file.md', markdown);

---

Command Line Usage

Generate a README.md file directly using the command line:

$ unifie-readme --help

  Usage:
    $ unifie-readme <input> <output>

  Options:
    --help, -h     Show help options
    --version, -v  Show version number

  Examples:
    $ unifie-readme input.txt output.md

Replace input.txt and output.md with the actual paths for your source and output files. The markdown file will be saved to output.md.

---

API

I/O Functions

Function	Description	Status
convertToMarkdown	📄 Converts text files into markdown format, ensuring consistency.	✅
loadTemplate	📥 Loads a predefined README template for customization.	✅
exportMarkdown	💾 Saves the generated markdown file to the specified location.	✅

Formatting Functions

Function	Description	Status
validateMarkdown	✔️ Validates markdown syntax and structure for standard formatting.	✅
addSection	➕ Adds a new section to the markdown template.	✅
removeSection	➖ Removes a specified section from the template.	✅

---

Documentation

• Configuration
• Design
• Build Guide
• Statistics

---

Authors

Maintained by Jinghao Hu.

---

Contributing

Special thanks to those who contributed to this project:

---

Join Us!

Spotted an error or have suggestions? Submit a pull request to improve UnifieReadme.

---

License

Distributed under the MIT License © 2024 Jinghao Hu | UCAS. See LICENSE for more details.