Code Monkey home page Code Monkey logo

comment-for-translation's Introduction

comment-for-translation

Check & Test

Description

This program aids translator (of program documents, mainly) by duplicating the contents and making them to comments. For example, original texts:

# Code Contributions
A guide on how to get started contributing code to the Gutenberg project.

will be processed as:

<!--
# Code Contributions
-->
# Code Contributions

<!--
A guide on how to get started contributing code to the Gutenberg project.
-->
A guide on how to get started contributing code to the Gutenberg project.

Then, translator can translate the contents.

<!--
# Code Contributions
-->
# コードでのコントリビューション

<!--
A guide on how to get started contributing code to the Gutenberg project.
-->
このガイドでは、Gutenberg プロジェクトにコードでコントリビュートする方法を説明します。

This method is easy to track the change of original texts because you can still use diff comand to identify the original text changes.

Usage

$ git clone [email protected]:atachibana/comment-for-translation.git
$ cd comment-for-translation
$ node cli.js <markdown-file>

Parameter

  • <markdown-file> target markdown file. Processed file will be filename-new.md. For example, test1.md will be test1-new.md.

Options

  • o, --output-dir Specify the directory to save files (default ./)

Development

% git clone [email protected]:atachibana/comment-for-translation.git
% cd comment-for-translation

(option: when you do not have node environment)
% docker compose up -d
% docker compose exec cli sh

% npm install
% npm test

comment-for-translation's People

Contributors

atachibana avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.