Skip to content

Commit e4c22ec

Browse files
authored
Merge pull request #14 from aklkv/feature/fix-md-linter
Feature/fix md linter
2 parents 4fb09d7 + 11b73d1 commit e4c22ec

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

guides/reference/windows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ the Administrators group must run their shell using Run As Administrator
5353
because UAC strips away certain permissions from the Administrators +group,
5454
including `SeCreateSymbolicLinkPrivilege`.
5555

56-
![Run As Administrator]({{ site.url }}/assets/images/common-issues/run-as-admin.png)
56+
![Run As Administrator](/assets/images/run-as-admin.png)
5757

5858
If the user account is not part of the Administrators group you will need to
5959
add the `SeCreateSymbolicLinkPrivilege` to allow the creation of symlinks. To
@@ -66,7 +66,7 @@ group has been added, your user should be able to create symlinks. Keep in mind
6666
if your user is part of the Administrators group and UAC is enabled you will
6767
still need to start your shell using `Run as Administrator`.
6868

69-
![Enabling Symlinks]({{ site.url }}/assets/images/common-issues/enabling-symlinks.png)
69+
![Enabling Symlinks](/assets/images/enabling-symlinks.png)
7070

7171
### Issues With npm: `EEXISTS`, Path too Long, etc
7272

guides/writing-addons/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ The result is the creation of a directory called `<addon-name>`, which has many
1818

1919
### Addon file structure
2020

21-
In some ways, an addon is like a mini Ember app. It has a very similar file structure, uses a lot of the same API methods, and can do most things that components are able to do.
21+
In some ways, an addon is like a mini Ember app. It has a very similar file structure, uses a lot of the same API methods, and can do most things that components are able to do.
2222

23-
Let's take a look a some of the most important files and folders in an addon, and how they are different from what we would find in an app.
23+
Let's take a look a some of the most important files and folders in an addon, and how they are different from what we would find in an app.
2424

25-
#### `addon/`
25+
#### `addon/`
2626

2727
This directory can hold many of the same subdirectories and files that an Ember app would, like `/components/` and `/templates/`. For developers who are making components, most of the work will happen here.
2828

29-
#### `app/`
29+
#### `app/`
3030

3131
The `app` directory plays an important role to help an Ember app automatically discover the components exported by an addon.
3232
The default way to make a component is to put the implementation in `addon/`, which allows developers to import and extend the addon component. However, Ember apps always look for components within the `app` namespace, so we must re-export our components from `app/`.
@@ -36,9 +36,9 @@ Fortunately, when we run `ember generate component my-component-name` in an addo
3636
#### `tests/dummy/`
3737
This directory contains a full Ember app for addon testing purposes. During tests, we can check to make sure that the addon works or looks as expected when it is used in an app. Many addon developers use the dummy app to hold their documentation site's content as well.
3838

39-
#### `package.json`
39+
#### `package.json`
4040

41-
If we want other people to be able to use our addon, we need to specify a name, license, version, the repository url, and description. For an addon to show up on [https://emberobserver.com](Ember Observer), it must have `keywords: ["ember-addon"]` and a repository URL.
41+
If we want other people to be able to use our addon, we need to specify a name, license, version, the repository url, and description. For an addon to show up on [Ember Observer](https://emberobserver.com), it must have `keywords: ["ember-addon"]` and a repository URL.
4242

4343
#### `config/ember-try.js`
4444

guides/writing-addons/tutorial.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ Our goal is to be able to pass the `buttonName` value to the addon, just like we
5050

5151
### Trying out the addon template in an app
5252

53-
There are several options to see the addon in action. We could use `npm link` or `yarn link` to try it out locally or publish the addon online. We'll use `link` while we are still developing and testing.
53+
There are several options to see the addon in action. We could use `npm link` or `yarn link` to try it out locally or publish the addon online. We'll use `link` while we are still developing and testing.
5454

55-
** From the addon project directory:**
55+
**From the addon project directory:**
5656
1. Since our addon uses a template, we need the template precompiler to be a `dependency` and not a `devDependency`. In the addon's `package.json`, move the entry for `ember-cli-htmlbars` into the `dependencies` listing. If this step is missed, there is a clear error message when we try to start the app that uses our addon.
5757
2. `yarn install` or `npm install`
5858
3. Run the command `yarn link` or `npm link`
5959

60-
** From the directory of the app using the addon:**
60+
**From the directory of the app using the addon:**
6161
1. `yarn link <addon-name>` or `npm link <addon-name>`.
6262
2. In the Ember app's `package.json`, add a `devDependencies` entry for your addon, like `"addon-name": "*"`. The `*` means that it will include all version numbers of our addon.
6363
3. Run `yarn install` or `npm install` in the app
@@ -67,17 +67,17 @@ There are several options to see the addon in action. We could use `npm link` or
6767
We should now see our addon in action!
6868

6969
**Having problems?**
70-
- Check to make sure that your `package.json` is valid, looking for missing commas or trailing commas.
71-
- "Template precompiler" errors mean that you skipped Step 1 and 2 above.
72-
- `404 not found` means we forgot to `yarn` or `npm install`
70+
- Check to make sure that your `package.json` is valid, looking for missing commas or trailing commas.
71+
- "Template precompiler" errors mean that you skipped Step 1 and 2 above.
72+
- `404 not found` means we forgot to `yarn` or `npm install`
7373
- Make sure all the files have been saved.
74-
- Did you rename or relocate any files after they were created? This is prone to mistakes, and the resulting errors can be really strange. It is best to create files using the CLI.
74+
- Did you rename or relocate any files after they were created? This is prone to mistakes, and the resulting errors can be really strange. It is best to create files using the CLI.
7575

7676
### Making a UI component available in block form
7777

7878
In an Ember app, components can be used in ["simple" or "block" form](https://guides.emberjs.com/release/components/wrapping-content-in-a-component/). Addon templates have the same capabilities. The simple form allows data objects or configuration values to be passed to the addon. The block form allows a developer to pass in their own template, content, and interactivity.
7979

80-
In an Ember app, a block style component uses the `{{yield}}` helper as a placeholder for where the passed-in content will go. It is the same in an Ember addon.
80+
In an Ember app, a block style component uses the `{{yield}}` helper as a placeholder for where the passed-in content will go. It is the same in an Ember addon.
8181

8282
Let's change our button addon we made earlier so that developers can pass in their own handlebars content by using the `{{yield}}` helper:
8383

@@ -141,9 +141,9 @@ Now any buttons made using our addon will have the `padding: 10px` rule applied.
141141

142142
For some addons, it makes sense to give the developer the option to import the stylesheet we provide, or import no stylesheets at all. Using this approach, we could even offer the developer a few themes to choose from.
143143

144-
We can do this by creating stylesheets in the `app/styles/` directory instead. These stylesheets share a file namespace with the consuming app and all the other addons someone is using, so name them wisely. For example, if we name our stylesheet `addon.css`, that's likely to clash. Just as before, it's important to choose uniquely named targets for the CSS rules so that they don't clash with other addons or the app.
144+
We can do this by creating stylesheets in the `app/styles/` directory instead. These stylesheets share a file namespace with the consuming app and all the other addons someone is using, so name them wisely. For example, if we name our stylesheet `addon.css`, that's likely to clash. Just as before, it's important to choose uniquely named targets for the CSS rules so that they don't clash with other addons or the app.
145145

146-
Let's create `app/styles/our-addon-name.css` and add a rule to it:
146+
Let's create `app/styles/our-addon-name.css` and add a rule to it:
147147

148148
```css
149149
/* addon/styles/our-addon-name.css */
@@ -175,7 +175,7 @@ The best way to learn how to use CSS preprocessors in your addon is to consult t
175175
There are two main types of JavaScript functionality that an addon can provide:
176176

177177
1. API methods that developers can use after importing your addon
178-
2. Interactive features that are part of UI components.
178+
2. Interactive features that are part of UI components.
179179

180180
We'll cover UI use cases first.
181181

@@ -250,7 +250,7 @@ This is a very tiny example of what addons can do in terms of providing JavaScri
250250

251251
## In-repo addons
252252

253-
If the addon is just meant to be used in a single project, an "in-repo" addon could be created instead. The benefits are that it is lightweight and the developer has access addon APIs, like adding packages and commands. However, there are some major limitations: an in-repo addon can't be shared between apps, versioned independently, or published to npm.
253+
If the addon is just meant to be used in a single project, an "in-repo" addon could be created instead. The benefits are that it is lightweight and the developer has access addon APIs, like adding packages and commands. However, there are some major limitations: an in-repo addon can't be shared between apps, versioned independently, or published to npm.
254254

255255
From within an existing Ember app, create an in-repo addon:
256256

@@ -268,7 +268,7 @@ The most common use case for an in-repo addon is when there is a chance a compon
268268

269269
## Documenting addons
270270

271-
For other developers to discover and use our addon, we need to teach them how to use it!
271+
For other developers to discover and use our addon, we need to teach them how to use it!
272272

273273
Here are the most common ways that addons provide user-facing documentation:
274274

126 KB
Loading

public/assets/images/run-as-admin.png

16.6 KB
Loading

0 commit comments

Comments
 (0)