在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):leebyron/spec-md开源软件地址(OpenSource Url):https://github.com/leebyron/spec-md开源编程语言(OpenSource Language):HTML 94.7%开源软件介绍(OpenSource Introduction):Spec MarkdownRenders Markdown with some additions into an HTML format commonly used for writing technical specification documents. Markdown additions include code syntax highlighting, edit annotations, and the definition of algorithms and grammar productions. Philosophy Spec Markdown is first and foremost Markdown. As such, it follows Markdown's philosophy of intending to be as easy to read and easy to write as is feasible. In order to interoperate with other tools which use Markdown, Spec Markdown tries to add as little additional syntax as possible, instead preferring conventions. This means any documents written with Spec Markdown in mind should render adequately by other Markdown renderers. To support the rendering additions of Spec Markdown, some features of Markdown may be limited or removed. As an example, Spec Markdown is strict about the order and locations of headers in a document. Note: This is not a normative spec for Spec Markdown, but just documentation of this tool. Of course, written in Spec Markdown! Getting StartedTo use Spec Markdown, just write Markdown files. There are some conventions used by Spec Markdown which you can read about in Spec additions. To convert your Markdown files into an HTML spec document, use the npm install -g spec-md
spec-md ./path/to/markdown.md > ./path/to/output.html You can also require npm install --save-dev spec-md const fs = require('fs');
const specMarkdown = require('spec-md');
specMarkdown.html('./path/to/markdown.md').then(html => {
fs.writeFile('./path/to/output.html', html);
}); Spec Markdown also provides utilities for generating and operating on an intermediate representation of the markdown, which you can explore in Using Spec Markdown. MarkdownSpec additionsUsing Spec MarkdownContributing |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论