Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix spelling mistakes and make the grammar correct #224

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix spelling mistakes and make the grammar correct #224

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a31378
Fix spelling mistakes and grammar
lulunac27a Jan 15, 2024
f9c2b54
Fix more spelling mistakes
lulunac27a Jan 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 23 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
EnlighterJS3
====================================================================

**EnlighterJS, an open source syntax highlighter written in pure javascript**
**EnlighterJS, an open-source syntax highlighter written in pure javascript**

Using it can be as simple as adding a single script and style to your website, choosing the elements you wish to highlight, and EnlighterJS takes care of the rest.
Using it can be as simple as adding a single script and style to your website, and choosing the elements you wish to highlight, and EnlighterJS takes care of the rest.

![Appearance](assets/enlighterjs_bootstrap4.png)

Expand All @@ -32,17 +32,17 @@ Features
* 40 supported languages/formats
* 12 high quality themes
* Inline Syntax highlighting
* Codegroups to displays multiple code-blocks within a tab-pane
* Codegroups to display multiple code blocks within a tab pane
* Point out special lines of code
* Ultra small footprint: `45KB JS` (all languages) + `10KB CSS` (single theme; all themes 60KB)
* Highlight all codeblocks on your page with a single command
* Ultra-small footprint: `45KB JS` (all languages) + `10KB CSS` (single theme; all themes 60KB)
* Highlight all code blocks on your page with a single command

#### TECHNICAL FEATURES ####

* Ultrafast Tokenizer Engine based on priorized regular expressions
* Ultrafast Tokenizer Engine based on prioritized regular expressions
* Second-Stage-Tokenizer for optimized performance
* Full customizable themes written in [less](http://lesscss.org/)
* Themes available as single css files to reduce footprint
* Themes available as single CSS files to reduce footprint
* Views based on [JSX](https://reactjs.org/docs/introducing-jsx.html)
* Minimal, embedded DOM library
* [gulp](https://gulpjs.com/) based build system
Expand Down Expand Up @@ -111,9 +111,9 @@ Features

* **Enlighter** (enlighter, standard) - Enlighter`s default Theme
* **Classic** (classic) - SyntaxHighlighter inspired
* **Bootstrap** (bootstrap4) - Bootstrap 4 inpired themes, high contrast
* **Bootstrap** (bootstrap4) - Bootstrap 4 inspired themes, high contrast
* **Beyond** (beyond) - BeyondTechnology Theme
* **Godzilla** (godzilla) - A MDN inspired Theme
* **Godzilla** (godzilla) - An MDN-inspired Theme
* **Eclipse** (eclipse) - Eclipse inspired
* **MooTwo** (mootwo) - Inspired by the MooTools Website
* **Droide** (droide) - Modern, minimalistic
Expand All @@ -125,15 +125,15 @@ Features
Quickstart
----------------------------------------------

1. Download latest [EnlighterJS release](https://github.com/EnlighterJS/EnlighterJS/releases)
1. Download the latest [EnlighterJS release](https://github.com/EnlighterJS/EnlighterJS/releases)
2. Copy the files from the `dist/` directory to your public html location
3. Include the CSS+JS files
4. Tag the codeblocks on your page (e.g. `pre` tags with `data-enlighter-language` attribute)
4. Tag the code blocks on your page (e.g. `pre` tags with `data-enlighter-language` attribute)
5. Initialize highlighting

### Minimal Example ###

This is a minimalistic example how to highlight sourcecode with EnlighterJS. The working example (valid js+css paths) is available within the [example directory](examples/).
This is a minimalistic example how to highlight source code with EnlighterJS. The working example (valid js+css paths) is available within the [example directory](examples/).

```html
<!DOCTYPE html>
Expand All @@ -153,9 +153,9 @@ This is a minimalistic example how to highlight sourcecode with EnlighterJS. The
et dolore <code>window.addEvent('domready', async (a,b) => {});</code> magna aliquyam erat.
</p>

<!-- Code to hghlight !-->
<!-- Code to highlight!-->
<pre data-enlighter-language="less">
// buttons used in codegroups + toolbar
// buttons used in code groups + toolbar
.enlighter-btn{
display: inline-block;
margin: 0px 5px 0px 5px;
Expand Down Expand Up @@ -183,15 +183,15 @@ This is a minimalistic example how to highlight sourcecode with EnlighterJS. The

<script type="text/javascript" src="enlighterjs.min.js"></script>
<script type="text/javascript">
// INIT CODE - simple page-wide initialization based on css selectors
// INIT CODE - simple page-wide initialization based on CSS selectors
// - highlight all pre + code tags (CSS3 selectors)
// - use javascript as default language
// - use theme "enlighter" as default theme
// - use javascript as the default language
// - use theme "enlighter" as the default theme
// - replace tabs with 2 spaces
EnlighterJS.init('pre', 'code', {
language : 'javascript',
language: 'javascript',
theme: 'enlighter',
indent : 2
indent: 2
});
</script>
</body>
Expand All @@ -201,16 +201,16 @@ This is a minimalistic example how to highlight sourcecode with EnlighterJS. The
Contribution
------------

EnlighterJS is OpenSource and managed on [GitHub](https://github.com/EnlighterJS/EnlighterJS) - if you like, you're welcome to contribute!
EnlighterJS is open source and managed on [GitHub](https://github.com/EnlighterJS/EnlighterJS) - if you like, you're welcome to contribute!
To simplify the release and quality control process, please follow these remarks:

1. **One Enhancement** _==>_ **One Commit** (don't merge a bunch of changes in a single commit!)
2. Only commit changes to the `src/` or `examples/` directory. Otherwise your request will be rejected
2. Only commit changes to the `src/` or `examples/` directory. Otherwise, your request will be rejected
3. Discuss larger project changes with the Maintainer **before implementing**
4. Use GitHub for question, bugreports and discussions
4. Use GitHub for questions, bug reports, and discussions

License
----------------------------------------------

EnlighterJS is OpenSource and licensed under the Terms of [Mozilla Public License 2.0](https://opensource.org/licenses/MPL-2.0). You're welcome to [contribute](docs/CONTRIBUTING.md)
EnlighterJS is open source and licensed under the Terms of [Mozilla Public License 2.0](https://opensource.org/licenses/MPL-2.0). You're welcome to [contribute](docs/CONTRIBUTING.md)