@abstractmark/abstractmark 中文文档教程
Javascript implementation of AbstractMark.
有关 Abstractmark 的更多信息，请访问此存储库。
AbstractMark CLI
要求：
- npm installed with its path registered on your system path. (You may ignore this if you installed npm in the proper way)
安装 输入
npm install @abstractmark/abstractmark -g。 为确保它安装正确，请键入abstractmark --help，它应该显示 abstractmark CLI 用法，如果没有，请打开一个问题。用法：
- For Converting Abstractmark file: run
abstractmark [abstractmark file] [abstractmark options] [args] - For Converting Abstractmark files inside a folder: run
abstractmark [folder] [abstractmark options args] - For Abstractmark's Information : run
abstractmark [option] - For more information about AbstractMark CLI, please type
abstractmark --helpon your terminal.
- For Converting Abstractmark file: run
Import AbstractMark
安装
在命令行中键入
npm install @abstractmark/abstractmark。用法：
import {AbstractMark} from "@abstractmark/abstractmark"to import AbstractMark- Pass your text to convert into AbstractMark function with your options, example:
AbstractMark("# Hello World {#Hi} {color:red}", {styled: true})
可用选项：
styled, convert your text into html tags with default styledfullHTMLTags, convert your text into full structured html tags.
Setup (development)
- Clone this repository by typing
git clone https://github.com/abstractmark/javascript.git abstractmarkand get into it by typingcd abstractmark - To start setting up abstractmark CLI, type
npm i -gto install it globally. To make sure abstractmark CLI is installed, typeabstractmark --help. For more information about CLI is also written there.
Code of Conduct
有关行为准则，请访问 CODEOFCONDUCT.md
Contributing Guidelines
感谢您有兴趣为 AbstractMark 做贡献！ 请花点时间查看此文档
License
AbstractMark 是根据MIT 许可证 分发的
Javascript implementation of AbstractMark.
For more information about Abstractmark, please visit this repository.
AbstractMark CLI
Requirement:
- npm installed with its path registered on your system path. (You may ignore this if you installed npm in the proper way)
Installation Type
npm install @abstractmark/abstractmark -g. To make sure it's installed properly, please typeabstractmark --help, it should shows abstractmark CLI usage, if it doesn't, please open an issue.Usage:
- For Converting Abstractmark file: run
abstractmark [abstractmark file] [abstractmark options] [args] - For Converting Abstractmark files inside a folder: run
abstractmark [folder] [abstractmark options args] - For Abstractmark's Information : run
abstractmark [option] - For more information about AbstractMark CLI, please type
abstractmark --helpon your terminal.
- For Converting Abstractmark file: run
Import AbstractMark
Installation
Type
npm install @abstractmark/abstractmarkon your command line.Usage:
import {AbstractMark} from "@abstractmark/abstractmark"to import AbstractMark- Pass your text to convert into AbstractMark function with your options, example:
AbstractMark("# Hello World {#Hi} {color:red}", {styled: true})
Available options:
styled, convert your text into html tags with default styledfullHTMLTags, convert your text into full structured html tags.
Setup (development)
- Clone this repository by typing
git clone https://github.com/abstractmark/javascript.git abstractmarkand get into it by typingcd abstractmark - To start setting up abstractmark CLI, type
npm i -gto install it globally. To make sure abstractmark CLI is installed, typeabstractmark --help. For more information about CLI is also written there.
Code of Conduct
For the Code of Conduct, please visit CODEOFCONDUCT.md
Contributing Guidelines
Thanks for your interest in contributing to AbstractMark! Please take a moment to review this document
License
AbstractMark is distributed under MIT License
