Code Monkey home page Code Monkey logo

markit's Introduction

Markit

专为中文语境优化的 Markdown 命令行工具

关于

该项目为从命令行使用markdown提供了一个简单的配套解决方案。

包含:

  • 格式化
  • 渲染

针对中文语境,它参考 中文文案排版指北 https://github.com/sparanoid/chinese-copywriting-guidelines

格式化处理项

  • 中英文之间增加空格(排除 "ing", 例如工作中,可能写为 "工作ing",这种情况不会自动加空格)
  • 专有名词使用正确的大小写(例如 自动将 github 转换为 Github)
  • 自动处理表格对齐(务必使用等宽字符)

可以提供整个项目文档的统一处理,特别是在处理 Gitbook 等项目时,能够在多人合作中实现格式统一。

默认使用.markit.toml 文件配置整个仓库的处理方式风格

Usage:
  markit [command]

Available Commands:
  format      格式化markdown文档
  help        Help about any command
  render      渲染markdown文档

Flags:
  -c, --config string   默认配置文件(将从指定路径及上层路径递归查找.markit.toml,如果未能找到将尝试查询$HOME/.markit.toml)
  -h, --help            help for markit

Use "markit [command] --help" for more information about a command.

安装

Go

go get -u github.com/zidoshare/markit

🙏 鸣谢

站在巨人们的肩膀上:

  • 中文文案排版指北:统一中文文案、排版的相关用法,降低团队成员之间的沟通成本,增强网站气质
  • lute:一款对中文语境优化的 Markdown 引擎,支持 Go 和 JavaScript。

markit's People

Contributors

zidoshare 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.