https://github.com/absaoss/cps-mdoc-viewer
Angular library utilized in constructing websites that host tutorials and documentation, providing reference materials to help users learn about a particular topic, tool, or technology. The content is supplied in the format of markdown documents. This repository comprises both the library itself and an example website constructed using it.
https://github.com/absaoss/cps-mdoc-viewer
Last synced: 8 months ago
JSON representation
Angular library utilized in constructing websites that host tutorials and documentation, providing reference materials to help users learn about a particular topic, tool, or technology. The content is supplied in the format of markdown documents. This repository comprises both the library itself and an example website constructed using it.
- Host: GitHub
- URL: https://github.com/absaoss/cps-mdoc-viewer
- Owner: AbsaOSS
- License: apache-2.0
- Created: 2024-04-26T10:20:03.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T08:05:42.000Z (11 months ago)
- Last Synced: 2025-06-02T05:23:25.355Z (8 months ago)
- Language: TypeScript
- Homepage: https://absaoss.github.io/cps-mdoc-viewer/
- Size: 603 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# CpsMdocViewer
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.6.
## Example app
Example app built using this library is available here [https://absaoss.github.io/cps-mdoc-viewer/](https://absaoss.github.io/cps-mdoc-viewer/).
## Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
## Code scaffolding
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
## Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
## Running unit tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.