Skip to content

Commit 5d0abd6

Browse files
committed
usage cleanup, convert raw html to md
1 parent 842be03 commit 5d0abd6

13 files changed

+431
-542
lines changed

CONTRIBUTING.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
First off, thanks for taking the time to contribute! ❤️
44

5-
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
5+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
66

77
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
88
>
@@ -82,11 +82,11 @@ Once it's filed:
8282

8383
- The project team will label the issue accordingly.
8484
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
85-
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
85+
- If the team can reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
8686

8787
### Suggesting Enhancements
8888

89-
This section guides you through submitting an enhancement suggestion for Selectize, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
89+
This section guides you through submitting an enhancement suggestion for Selectize, **including entirely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your request and find related suggestions.
9090

9191
#### Before Submitting an Enhancement
9292

@@ -102,7 +102,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/select
102102
- Use a **clear and descriptive title** for the issue to identify the suggestion.
103103
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
104104
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point, you can also tell which alternatives do not work for you.
105-
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part to which the suggestion is related. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
105+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part to which the suggestion is related. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
106106
- **Explain why this enhancement would be useful** to most Selectize users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
107107

108108
### Your First Code Contribution
@@ -117,9 +117,9 @@ Running `make` will build the project, run all tests, and update the distributio
117117

118118
Running `npm start` on your repo will start a web server allowing you to view a local copy of this documentation, where you can test your changes against our example pages.
119119

120-
If you are adding a new plugin, you should also add a corresponding example page to the `/docs/docs/plugins` directory.
120+
If you are adding a new plugin, you should add a corresponding example page to the `/docs/docs/plugins` directory.
121121

122-
You can then run the examples at `http://localhost:4000/`.
122+
You can then run the examples at `https://loopback.website:4000/`.
123123

124124
### Improving The Documentation
125125

@@ -134,7 +134,5 @@ If you're motivated to fix a bug or to develop a new feature, we'd love to see y
134134
- Make sure tests pass: Run `npm test` to make sure your changes don't break existing functionality
135135
- Do not make changes to files in `/dist`. Limiting your edits to files in `/src` directories keeps the size of your pull request down and makes it easier for us to evaluate. We'll update the `/dist` folder after your pull request is approved.
136136
- Add tests: In the best-case scenario, you are also adding tests to back up your changes, but don't sweat it if you don't. We can discuss them at a later date.
137-
- Squash your commits together in one or a few complete, logical commits,
138-
with a concise and descriptive message. One commit means one
139-
feature/bugfix/thing that has changed, or a diff bringing the code one
140-
step forward to a better, working state.
137+
- Squash your commits together in one or a few complete, logical commits with a concise and descriptive message. One commit means one
138+
feature/bugfix/thing that has changed or a diff bringing the code one step forward to a better, working state.

docs/docs/code-of-conduct.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Code of conduct
66

77
## Our Pledge
88

9-
We as members, contributors, and leaders pledge to make participation in our
9+
We, as members, contributors, and leaders, pledge to make participation in our
1010
community a harassment-free experience for everyone, regardless of age, body
1111
size, visible or invisible disability, ethnicity, sex characteristics, gender
1212
identity and expression, level of experience, education, socio-economic status,
@@ -19,14 +19,14 @@ diverse, inclusive, and healthy community.
1919
## Our Standards
2020

2121
Examples of behavior that contributes to a positive environment for our
22-
community include:
22+
community includes:
2323

2424
- Demonstrating empathy and kindness toward other people
2525
- Being respectful of differing opinions, viewpoints, and experiences
2626
- Giving and gracefully accepting constructive feedback
2727
- Accepting responsibility and apologizing to those affected by our mistakes,
2828
and learning from the experience
29-
- Focusing on what is best not just for us as individuals, but for the
29+
- Focusing on what is best not just for us as individuals; but for the
3030
overall community
3131

3232
Examples of unacceptable behavior include:
@@ -36,7 +36,7 @@ Examples of unacceptable behavior include:
3636
- Trolling, insulting or derogatory comments, and personal or political attacks
3737
- Public or private harassment
3838
- Publishing others' private information, such as a physical or email
39-
address, without their explicit permission
39+
address without their explicit permission
4040
- Other conduct which could reasonably be considered inappropriate in a
4141
professional setting
4242

@@ -54,10 +54,10 @@ decisions when appropriate.
5454

5555
## Scope
5656

57-
This Code of Conduct applies within all community spaces, and also applies when
57+
This Code of Conduct applies within all community spaces and also applies when
5858
an individual is officially representing the community in public spaces.
5959
Examples of representing our community include using an official e-mail address,
60-
posting via an official social media account, or acting as an appointed
60+
posting via an official social media account or acting as an appointed
6161
representative at an online or offline event.
6262

6363
## Enforcement

docs/docs/demos/email.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: email-contact
33
title: Custom Rendering and Validation
4-
description: This demonstrates two main things, (1) custom item and option rendering, and (2) item creation on-the-fly. Try typing a valid and invalid email address.
4+
description: This demonstrates two main things, (1) custom item and option rendering and (2) item creation on-the-fly. Try typing a valid and invalid email address.
55
---
66

77
import EmailContact from '@site/src/components/Examples/EmailContact';

docs/docs/glossary.mdx

-20
This file was deleted.

docs/docs/intro.mdx

+17-20
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
---
33

4-
import Tabs from '@theme/Tabs';
5-
import TabItem from '@theme/TabItem';
4+
import Tabs from "@theme/Tabs";
5+
import TabItem from "@theme/TabItem";
66

77
# Getting Started with Selectize
88

@@ -12,7 +12,7 @@ Selectize is a JavaScript library that provides a rich user experience for selec
1212

1313
### What you'll need
1414

15-
Selectize requires jQuery. We also include styles for bootstrap, but also provide raw Less and Sass files for you to customize with any framework you like.
15+
Selectize requires jQuery. We also include styles for bootstrap and provide raw Less and Sass files for you to customize with any framework you like.
1616

1717
If you want to use the Drag & Drop plugin, you'll need jQuery UI.
1818

@@ -37,23 +37,20 @@ yarn add @selectize/selectize
3737

3838
### Install with cdn
3939

40-
The fastest way to add Selectize into your project is to just include the js and css from jsDelivr.
40+
The fastest way to add Selectize to your project is to include the js and css from [cdnjs](https://cdnjs.com/libraries/selectize.js).
4141

4242
```html
43-
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.14.0/css/selectize.css" integrity="sha512-ikoGg2i+6jXI1u0qXylbyIb+9f9/z/fVQR4kor0Dmt3oTIb/ZnOZ33POmdUitzXTDrd5XCpQUhsiXnl/oTuiHA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
44-
<script src="https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.14.0/js/standalone/selectize.min.js" integrity="sha512-EZjqrrnoamnlzX1VpHSu7mCYXpbVJdqeJBbpPIHdfH/AtF8Lp/jKrCzYqzKSuVjxriFkEWR0I3qoT2evvrvRmw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
45-
```
46-
47-
## Usage
48-
49-
In its simplest form, Selectize can be initialized on an existing `<select>` element:
50-
51-
```html
52-
<script type="text/javascript" src="selectize.js"></script>
53-
<link rel="stylesheet" type="text/css" href="selectize.css" />
54-
<script>
55-
$(function () {
56-
$("select").selectize(options);
57-
});
58-
</script>
43+
<link
44+
rel="stylesheet"
45+
href="https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.15.2/css/selectize.default.min.css"
46+
integrity="sha512-pTaEn+6gF1IeWv3W1+7X7eM60TFu/agjgoHmYhAfLEU8Phuf6JKiiE8YmsNC0aCgQv4192s4Vai8YZ6VNM6vyQ=="
47+
crossorigin="anonymous"
48+
referrerpolicy="no-referrer"
49+
/>
50+
<script
51+
src="https://cdnjs.cloudflare.com/ajax/libs/selectize.js/0.15.2/js/selectize.min.js"
52+
integrity="sha512-IOebNkvA/HZjMM7MxL0NYeLYEalloZ8ckak+NDtOViP7oiYzG5vn6WVXyrJDiJPhl4yRdmNAG49iuLmhkUdVsQ=="
53+
crossorigin="anonymous"
54+
referrerpolicy="no-referrer"
55+
></script>
5956
```

docs/docs/plugins/restore-backspace.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ title: Restore on Backspace
44
description: Press the [backspace] key and go back to editing the item without it being fully removed.
55
---
66

7-
import RestoreBacspace from '@site/src/components/Examples/Plugins/RestoreBacspace';
7+
import RestoreBackspace from '@site/src/components/Examples/Plugins/RestoreBackspace';
88

9-
<RestoreBacspace />
9+
<RestoreBackspace />

0 commit comments

Comments
 (0)