kalaiser / awesome-cdk

A collection of awesome things related to the AWS Cloud Development Kit (CDK)
Creative Commons Zero v1.0 Universal
2.01k stars 197 forks source link

Enable MkDocs Material on this repo #37

Closed dgomesbr closed 4 years ago

dgomesbr commented 4 years ago

labels: autosquash assignees: eladb

Several post-changes have to be made by you as you own the repo:


You can review other customizations I made directly on the mkdocs.yml on the root folder, refer to Getting Started for information on how to customize colors, font, the main icon, etc.

If you don't want to auto-update the gh-pages on every commit/pr, you can always use the mkdocs gh-deploy --clean or make site_deploy from your local env.

I've also provided custom vscode tasks that enable you to do that.

This also closes #36

dgomesbr commented 4 years ago

@eladb got the images and the tracking code? I can merge them if you need.

eladb commented 4 years ago

Hi @dgomesbr, so I took this for a spin to see how the result looks like. It's very nice, and I really really appreciate the effort, but I am not sure this adds much value over the GitHub README experience, so I am going to pass on this one.

Again, truly appreciate the effort and contribution!