prism README

The project's README from github.com/PrismJS/prism. As one markdown file: README.md.

Prism

Build Status npm

Prism is a lightweight, robust, and elegant syntax highlighting library. It's a spin-off project from Dabblet.

You can learn more on prismjs.com.

Why another syntax highlighter?

More themes for Prism!

Contribute to Prism!

Important Notice

We are currently working on Prism v2 and will only accept security-relevant PRs for the time being.

Once work on Prism v2 is sufficiently advanced, we will accept PRs again. This will be announced on our Discussion page and mentioned in the roadmap discussion.

Prism v1 contributing notes

Prism depends on community contributions to expand and cover a wider array of use cases. If you like it, consider giving back by sending a pull request. Here are a few tips:

  • Read the documentation. Prism was designed to be extensible.
  • Do not edit prism.js, it’s just the version of Prism used by the Prism website and is built automatically. Limit your changes to the unminified files in the components/ folder. prism.js and all minified files are generated by our build system (see below).
  • Use npm ci to install Prism's dependencies. Do not use npm install because it will cause non-deterministic builds.
  • The build system uses gulp to minify the files and build prism.js. With all of Prism's dependencies installed, you just need to run the command npm run build.
  • Please follow the code conventions used in the files already. For example, I use tabs for indentation and spaces for alignment. Opening braces are on the same line, closing braces on their own line regardless of construct. There is a space before the opening brace. etc etc.
  • Please try to err towards more smaller PRs rather than a few huge PRs. If a PR includes changes that I want to merge and also changes that I don't, handling it becomes difficult.
  • My time is very limited these days, so it might take a long time to review bigger PRs (small ones are usually merged very quickly), especially those modifying the Prism Core. This doesn't mean your PR is rejected.
  • If you contribute a new language definition, you will be responsible for handling bug reports about that language definition.
  • If you add a new language definition or plugin, you need to add it to components.json as well and rebuild Prism by running npm run build, so that it becomes available to the download build page. For new languages, please also add a few tests and an example in the examples/ folder.
  • Go to prism-themes if you want to add a new theme.

Thank you so much for contributing!!

Software requirements

Prism will run on almost any browser and Node.js version but you need the following software to contribute:

  • Node.js >= 10.x
  • npm >= 6.x

Translations

prism (PrismJS/prism)

Searching Database…

13.1K ·GitHub
Что это такое?Prism — это лёгкая, надёжная и элегантная библиотека для подсветки синтаксиса в вебе; она выросла из проекта Dabblet.
Это то, что я добавляю на свою веб-страницу, или отдельная программа, которую я запускаю?Это JavaScript-библиотека, а не самостоятельное приложение: Prism работает практически в любом браузере и в любой версии Node.js, так что вы подключаете его к своей странице, и он подсвечивает код прямо там.
Как добавить его на свой сайт?Соберите собственную сборку на странице загрузки на prismjs.com, выбрав именно те языки и плагины, которые вам нужны, или установите пакет prismjs через npm.
Что нужно установить, чтобы пользоваться им и чтобы работать над его кодом?Чтобы пользоваться, ничего — у Prism нет зависимостей во время работы, и он запускается практически в любом браузере. Для участия в разработке нужны Node.js >= 10.x и npm >= 6.x, а зависимости обязательно ставить командой npm ci, потому что npm install приводит к нестабильным, невоспроизводимым сборкам.
Зачем ещё один подсветчик синтаксиса?В README задан именно этот вопрос, и короткий ответ начинается так: больше тем. Prism задуман как расширяемая библиотека: языки и плагины — это отдельные компоненты, из которых вы выбираете нужные при сборке.
Какие языки он подсвечивает сразу, «из коробки»?Довольно широкий набор — определения языков поставляются отдельными компонентами, охват растёт благодаря вкладам сообщества, а на странице загрузки можно включить ровно те, что вам нужны.
Как добавить поддержку совершенно нового языка?Положите неминифицированное определение в папку components/, зарегистрируйте его в components.json и выполните npm run build, чтобы язык появился на странице загрузки. Стоит также добавить несколько тестов и пример — и учтите, что после этого вы отвечаете за сообщения об ошибках в вашем определении языка.
Могу ли я создать собственную цветовую тему?Да — новые темы нужно размещать в отдельном репозитории prism-themes, а не в основном репозитории Prism.
Creator
PrismJS
Size
14.7 MB
Stars
13.1K
Age
14y
Commits · 90 Days