highlightjs / highlightjs/highlightjs-bbcode

Please include both a NPM requirable file and a CDN-ready distributable

未关闭
#2 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
JavaScript
星标
7
派生
2
PR 合并指标
30 天内没有已合并 PR

描述

This issue is being opened as part of [our iniative](https://github.com/highlightjs/highlight.js/issues/3008) to make all 3rd party grammars:

- easier to use for all end users
- internally a bit more consistent (both to help end users and also encourage cross-maintenance)
- ready to go for version 11

Please include a `dist` folder that includes a ready-to-go CDN distributable that can be used with a single line of JS. IE, our simple 3 install should "just work" without any other code or markup:

```

hljs.highlightAll();
```

Your README optimally would also document this usage. Please see the `robots-txt` repository for a usage example.

- https://github.com/highlightjs/highlightjs-robots-txt#static-website-or-simple-usage

Our build system can generate this file for you (and we recommend that). Using our internal build system also allows you to easily check your grammar for exponential or polynomical run-away regular expressions.

- https://github.com/highlightjs/highlight.js/blob/main/extra/3RD_PARTY_QUICK_START.md#packaging

If you have any questions, feel free to ask!

Thanks,
Highlight.js Maintainer

---

You only have a single file now... which doesn't work with Node.js. Your source file should have a single export (the language function).. your distributable file should include the `registerLanguage` call. See the robots-txt repository linked to above for examples (I see you forked from that repo).

IE, the `src/languages/bbcode.js` file is the one you maintain (and can be required by Node.js, etc), and the `dist/bbcode.min.js` file is the one that our build system would auto-generate for you.

贡献指南

这个仓库没有索引到贡献指南

调研方向

Start with src/languages/bbcode.js and the packaging section of extra/3RD_PARTY_QUICK_START.md, then compare the robots-txt repository example. The source should be requireable by Node.js, while the build should produce dist/bbcode.min.js with the registerLanguage call; update the README with CDN usage and verify both usage paths.

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
build-system
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
描述清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。