Skip to content
This repository was archived by the owner on Sep 26, 2022. It is now read-only.

Commit aa027b5

Browse files
docs: formatting, better contributing docs
Signed-off-by: Florian-Schoenherr <[email protected]>
1 parent abde05a commit aa027b5

File tree

3 files changed

+25
-13
lines changed

3 files changed

+25
-13
lines changed

packages/docs/src/routes/getting-started/contributing.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,17 @@ Before reporting an issue, ensure that you:
1818

1919
- have tried providing a [REPL](https://svelte.dev/repl/9982308600f043f3aeb43fb3b17f35b5?version=3.37.0)
2020

21-
## Setting up your environment
21+
## Working on Svelte Materialify
22+
### Setting up your environment
2223

2324
Follow these instructions if you are planning to make a pull request.
2425

25-
## Getting the source
26+
### Getting the source
2627

2728
1. Register to [Github](https://github.com/)
2829
2. Navigate to [svelte-materialify](https://github.com/TheComputerM/svelte-materialify)
2930
3. Press the fork button in the top right corner of the screen
30-
4. Copy the url of your browser, it should now be: https://github.com/**your_github_user_id**/svelte-materialify
31+
4. Copy the url of your browser, it should now be: `https://github.com/{your_github_user_id}/svelte-materialify`
3132
5. On your PC, open a command prompt window and type the following commands
3233

3334
```shell
@@ -37,7 +38,7 @@ $ cd svelte-materialify
3738

3839
This will get the entire repository on your machine, now we can build the library.
3940

40-
## Building
41+
### Building
4142

4243
Building is done with yarn (**not** npm).
4344
From the **root folder**, install the dependencies by typing:
@@ -64,12 +65,21 @@ To build the API, which provides the definitions and types for the different pro
6465
yarn api
6566
```
6667

67-
## Submitting your change
68+
### Submitting your change
6869

69-
After making a change, make sure it works well by running `yarn lint` and `yarn test`, then commit your changes following [conventional commit syntax](https://github.com/conventional-changelog/commitlint/#what-is-commitlint).
70+
After making a change, make sure it works well by running:
71+
```shell
72+
yarn lint
73+
```
74+
and
75+
```shell
76+
yarn test
77+
```
78+
Please commit your changes following [conventional commit syntax](https://github.com/conventional-changelog/commitlint/#what-is-commitlint), for example:
79+
```shell
80+
git commit -m "docs: improve contributing.md"
81+
```
7082

71-
For example:
72-
`docs: improve contributing.md`
83+
Then, **git push** your changes to your github repository.
7384

74-
Then, push your changes to your github repository.
75-
Finally, from the github repository web page, you can click the Pull Request button and a contributor will review the changes you made.
85+
Finally, from the github repository web page, you can click the **Pull Request** button and a contributor will review the changes you made.

packages/docs/src/routes/getting-started/installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ $ npm i -D svelte-materialify svelte-preprocess sass postcss
3737
```
3838

3939
Now create a **\_material-theme.scss** file. Let's put it in a folder called **theme**.
40+
4041
Include the folder path in the `sveltePreprocess` function in your **rollup.config.js**:
4142

4243
```js

packages/docs/src/routes/getting-started/usage.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ In your svelte files, import the _uncompiled_ module `from 'svelte-materialify/s
4343
```
4444
## Layout
4545

46-
All components should be children of `MaterialApp`, which has all the **global styles** and enables theming:
46+
All components should be children of `MaterialApp`, which provides all the **global styles** and enables theming:
4747

4848
```html
4949
<script>
@@ -71,7 +71,8 @@ If you don't want any global styles (other than theming and colors), you can use
7171

7272
## Theming
7373

74-
You want to customise some SCSS variables? Worry not, just put them in the **\_material-theme.scss** you had created:
74+
You want to customise some SCSS variables?
75+
Worry not, just put them in the **\_material-theme.scss** you had created:
7576

7677
```scss
7778
$primary-color: #004d26;
@@ -93,6 +94,6 @@ To access these variables in your own components, just import the variable file
9394

9495
<Components.Alert type='info'>
9596

96-
If you want to use SCSS and SASS styles in your own components, [use svelte-preprocess](https://github.com/sveltejs/svelte-preprocess/blob/master/docs/usage.md).
97+
If you want to use SCSS and SASS styles in your own components, [use svelte-preprocess](https://github.com/sveltejs/svelte-preprocess/blob/main/docs/usage.md).
9798

9899
</Components.Alert>

0 commit comments

Comments
 (0)