This PR with integrate a beautiful, static documentation site based on MkDocs which will then be hosted on GitHub Pages. The base Mkdocs docs will implemented along with third-party elegant & simplistic mkdocs-material theme. Furthermore, the docs will be build and deployed automatically on gh-pages through GitHub Actions workflow. Also, this enhancement will introduce new Docs related updates like new brand logo, gifs, etc. assets to bring standard and quality to Docs visual design.
Progress So far
🍱 Docs: Update Deffcode image assets.
💄 Added new icon ICO file with each layer of the favicon holds a different size of the image.
🚸 Added new png images for best compatibility with different web browsers.
🍱 Added new Deffcode banner image.
🚸 Updated Deffcode Logo and Tagline to be dark-mode friendly.
Related Issue
1
Context
This PR will implement of Deffcode Docs to with a beautiful, static documentation site based on MkDocs which will then be hosted on GitHub Pages. The base Mkdocs docs will implemented along with third-party elegant & simplistic mkdocs-material theme.
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to change)
Brief Description
This PR with integrate a beautiful, static documentation site based on MkDocs which will then be hosted on GitHub Pages. The base Mkdocs docs will implemented along with third-party elegant & simplistic
mkdocs-materialtheme. Furthermore, the docs will be build and deployed automatically on gh-pages through GitHub Actions workflow. Also, this enhancement will introduce new Docs related updates like new brand logo, gifs, etc. assets to bring standard and quality to Docs visual design.Progress So far
Related Issue
1
Context
This PR will implement of Deffcode Docs to with a beautiful, static documentation site based on MkDocs which will then be hosted on GitHub Pages. The base Mkdocs docs will implemented along with third-party elegant & simplistic
mkdocs-materialtheme.Types of changes