Place plugin docs along with their source code #3930
Conversation
✅ Deploy Preview for dev-prismjs-com ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| If you need more control, you can provide a function to `registerButton` that returns either a `span`, `a`, or `button` element. | ||
|
|
||
| ```js |
There was a problem hiding this comment.
This applies to other demo.js files (but possibly not all): Instead of including a separate demo.js that basically duplicates what is here, can we have a class or something that we can add to code examples and have them get a "Run" button?
There was a problem hiding this comment.
Yes, that makes sense. Though I think there is a demo.js file that should have another name: it's just a script that runs some functionality on the docs page, not related to demos (IIRC, it's related to the autoloader plugin). I should revert its name to script.js.
|
Also, we'll eventually do this for v1 too, right? |
Yeah, I'd rather work on proposed improvements a bit later.
Something like that, yes. Except we don't build the v1 website with 11ty; I figure that's fine, though, since eventually, it might become some sort of archive website. |
We should. We've already done most of the work! And we'd want to update the v1 website even before v2 launches, e.g. to add a banner to let people know that we're working on v2, or to improve its IA and the list of websites using Prism, etc. |
Let's do it, then! 🙂 |
* Place plugin docs along with their source code (#3930) * [autoloader] Fix script name in the docs * [normalize-whitespace] Don't consider demo as a plugin * Generate `file-sizes.json` during the build (#3946) * Exclude plugins' `demo.js` files from type checking * Fix path to the core entry point in `components.json` * Move and rename themes (#3947) - Move themes to the `src` folder and remove the `prism-` prefix - Adjust the build process accordingly - Adjust themes' metadata: - Remove broken links - Add/update authors' full names - Update GitHub handles - Use Markdown-style links - In `components.json`, fix theme ids and add Lea Verou as the owner to the prism, dark, and funky themes * Update themes' docs (#3958) So that they follow the structure (we can parse and use on the website): ``` /** * <title> * * <description> * * @author <name> (<GitHub_username>) */ ``` Between the data chunks, there should be at least one empty line. * Move `combineCallbacks` to its own module (#3963) * Move the `Token` class under the `classes` folder * Move all utils for working with iterables to a separate module Remove unused utils * Simplify hooks * Move the `Prism` class, add Prism singleton * Simplify the `Prism` class Move to separate modules: - `highlightAll()` - `highlightElement()` - `highlight()` - `stringify()` * Correctly parse CLI arguments (#3972) Was fixed in #3949 (in the `simplify` branch). Move it here to make testing easier. * Simplify the `Prism` class even more - Move `tokenize()`, `_matchGrammar()` (and related code), and `resolve()` to separate modules. - Ditch the `tokenize` symbol in favor of the `$tokenize` special property. Since symbols are excluded from the `for…in` loop, and `$tokenize` is not a symbol, to preserve the previous behavior, we need to handle it in `_matchGrammar` explicitly. - Switch from `[tokenize]` to `$tokenize` in languages. --- Co-authored-by: Dmitry Sharabin <dmitrysharabin@gmail.com> * Ditch the `rest` symbol in favor of the `$rest` special property * Move language utils to `util/` and separate them out * Remove known plugins + type safety * Move `documentReady` to async utils * Make the global bundle of Prism v2 work the same way as Prism v1 does Now, the user can include Prism the way they used to (except v2 now uses the Autoloader plugin under the hood, so more languages can be highlighted right out of the box): ```html <link rel="stylesheet" href="themes/prism.css" /> <script src="prism.js"></script> ``` Besides, they have access to the Prism instance via `globalThis`. * Move Prism config to a separate file and fix the build options of the global bundle Co-Authored-By: Dmitry Sharabin <dmitrysharabin@gmail.com> * Fix some code after merging --------- Co-authored-by: Lea Verou <lea@verou.me>
No description provided.