Builder of Bits aka The MDN Web Docs interactive examples, example builder
Builder of Bits aka The MDN Web Docs interactive examples example builder.
If you want to contribute to BoB, please follow these steps:
Thank you for your interest in contributing to MDN Web Docs.
NOTE: By contributing to BoB and MDN Web Docs you acknowledge that you have read and agree to our code of conduct.
-editor # All files related to the interactive examples editor
|--> css
|--> js
|--> media # media used only by the editor
|--> tmpl
-live-examples # All example related files and media (only used for testing purposes)
|--> css-examples
|--> fonts # fonts used by the editor and examples
|--> html-examples
|--> js-examples
|--> mathml-examples
|--> media # media used only by the examples
-docs
|--> css # All editor related CSS
|--> js # All editor related JS
|--> live-examples # All custom CSS and JS for the examples
|--> media # All media and fonts for the examples
|--> pages # All generated interactive example pages
|----> css # All CSS examples
|----> js # All JS examples
|----> tabbed # All examples using the tabbed UI
|----> wat # WebAssembly examples
|----> mathml # MathML examples
|----> webapi-tabbed # Web API examples (not currently used in production)
As mentioned above, this repository contains a couple of representative examples that you can use to test Bob. For most use cases, this should be enough and allow you to test your changes without installing BoB locally and integrating it with the interactive examples repository.
To test your changes, run:
npm start
You should see output similar to the following:
MDN-BOB: Cleaning or creating ./docs/....
MDN-BOB: Copying static assets....
MDN-BOB: Compiling editor JavaScript....
MDN-BOB: ../editor/js/editable-css-bundle.js written to disk
MDN-BOB: ../editor/js/editable-js-bundle.js written to disk
MDN-BOB: ../editor/js/editable-wat-bundle.js written to disk
MDN-BOB: ../editor/js/editor-bundle.js written to disk
MDN-BOB: Pages built successfully
This will build the local examples and startup a local server serving the examples. Navigate to localhost:4444 and open one of the examples to test your changes.
When working on changes to BoB, you might need to test against more examples than those that are a part of this repository. In those cases, you will need to run a local version of Bob inside the interactive-examples repo. Use the following command from the root of your local copy of the interactive-examples repo:
npx install-local ~/path/to/bob && node node_modules/.bin/mdn-bob
If you get stuck while working on BoB, there are a couple of ways to get help.
FAQs
Builder of Bits aka The MDN Web Docs interactive examples, example builder
The npm package @mdn/bob receives a total of 155 weekly downloads. As such, @mdn/bob popularity was classified as not popular.
We found that @mdn/bob demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.