Skip to content

chore(docs): some simple corrections #418

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

Merged
merged 2 commits into from
Apr 20, 2023
Merged

chore(docs): some simple corrections #418

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7f8533
chore(docs): some simple corrections
mfranzke Apr 18, 2023
2fbb534
Merge branch 'main' into chore-docs-corrections
mfranzke Apr 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/getStarted.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@ You're a Web Developer and you want to use DB UI Core in your own application. E

There are multiple options how to use DB UI Core:

* Manually copy the artifacs to your project
* Manually copy the artifacts to your project
* Use npm package

## How to use

Download DB UI Core to get the compiled CSS (and the small parts of JavaScript), source code, or include it with npm package manager (repository on _npmjs.com_ or _yarn_).

Previous to that you would need to have `node.js` installed on your local machine. In case you haven't we recommend installing `node` via [`nvm`](https://github.com/nvm-sh/nvm).
Previous to that you would need to have `node.js` installed on your local machine. In case you haven't we recommend installing `node` via link:https://github.com/nvm-sh/nvm[`nvm`].

### Use _npmjs.com_ or _yarn_ (installing npm package, recommended)

In case you'd like to use DB UI Core as a dependency in your (frontend) build process and you even also care about handling DB UI Core as a dependency (e.g. for updates etc.), you need to install it as a dependency to your project and then link it within your HTML (CSS file) or within your SCSS.
Please have a look into the link:docs/getStarted.adoc[Docs / Get Started] for detailed instructions.

[source,bash]
----
Expand Down Expand Up @@ -167,7 +168,7 @@ For Rollup based bundlers like Vite or Parcel we're providing the following SCSS

### Use css files:

If you want to use the compiled CSS directly, you can refence the css files in your index.html like this:
If you want to use the compiled CSS directly, you can reference the css files in your index.html like this:

[source,html]
----
Expand Down