Skip to content

Comments for Documentation added #132

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
hannobunjes merged 2 commits into from
May 6, 2024
Merged

Comments for Documentation added #132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a119e53
Comments for Documentation added
Martina-Graeber-One-Identity Mar 28, 2024
8432d1c
update
Apr 16, 2024
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,22 @@ We plan to push updates for each minor and major product release, allowing devel
- [Theming guide](./imxweb/custom-theme/readme.md)
- [CDR guide](./imxweb/projects/qbm/src/lib/cdr/Readme.md)

## Documentation

There are two ways to install the documentation locally. The result will be stored in _\imxweb\documentation\<projectname>_.

### 1. Using Compodoc (preferred)
1. Install the Compodoc package globally by running `npm install -g @compodoc/compodoc`.
2. Navigate to the library to create documentation for (e.g. `imxweb\projects\qer`).
3. Run `compodoc -p tsconfig.lib.json` for a library or `compodoc -p tsconfig.app.json` for an application.

### 2. Using npm only

This method only works for `qbm`, `qer` and the applications.

1. Navigate to _imxweb_.
2. run `npm run doc:<projectname>`

## Contributing

We welcome and appreciate contributions. Here's how you can open a pull request to submit code changes.
Expand Down