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.

CpsMdocViewer

This project was generated with Angular CLI version 17.3.6.

Example app

Example app built using this library is available here 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.

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 page.

cps-mdoc-viewer's Issues

Add readme instructions

Remove .vscode folder

Remove .vscode folder from the repository.

Get rid of bootstrap dependency

Utilize the CpsTableComponent

We're exploring options to add filtering, sorting, and search functionalities to tables within markdown files.
Such controls are already available in CpsTableComponent, so we need to make use of it in the current project.
Some investigation is needed to determine whether current ngx-markdown library supports rendering md with custom HTML templates. If this is not the case, another potential approach is to utilize a different tool for converting markdown to HTML, e.g. https://github.com/ericleib/ngx-remark or something else available that provides such capabilities.

Deploy example app to github pages

Move markdown viewer code from internal repo

Support for SSG to improve performance

Tooltips support

Infrastructure investigations

• Investigate creation of custom angular cli builder that would generate categories.json file, so that it wouldn't be necessary to run separate process for this purpose
• Investigate support for SSG to improve performance
• Add schematics to make setup easier for library consumers

Tasks

Beta Give feedback

1. Support for SSG to improve performance #10
   enhancement infrastructure +2