Skip to content
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.

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

feature-request(docs): style improvements (syntax highlighting, strong side- and toolbar) #230

Open
ngfelixl opened this issue Nov 22, 2019 · 1 comment

Comments

@ngfelixl
Copy link
Member

ngfelixl commented Nov 22, 2019

The docs page is the main entry point to this library and it should look a bit more friendly in order to gain more users. Two suggestions:

1.) We could add syntax highlighting for the example code in the docs page at https://interfacewerk.github.io/iwerk-angular-ui/#/. Prism.js or highlight.js seem to be promising. Compodoc has prism.js support.

2.) We should use a different color for the side- and toolbar. Suggestion: The accent color is the interfacewerks logos orange. Can we use the interfacewerks logos blue as the background color for these to items?

@ngfelixl
Copy link
Member Author

In addition to that, can we add a logo of interfacewerk with link to https://interfacewerk.de in the readme? This page is displayed on NPM as a repo description and is quite a good place to refer the interfacewerk website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant