Add MkDocs documentation site with Material theme #503
Open
cendhu wants to merge 2 commits intohyperledger:mainfrom
Open
Add MkDocs documentation site with Material theme #503cendhu wants to merge 2 commits intohyperledger:mainfrom
cendhu wants to merge 2 commits intohyperledger:mainfrom
Conversation
Signed-off-by: Senthilnathan <cendhu@gmail.com>
Set up MkDocs with Material theme to publish project documentation on GitHub Pages. Adds mkdocs.yml configuration, a custom landing page (docs/index.md), a GitHub Actions workflow to deploy on push to main, and a CI check to validate the docs build on pull requests. Signed-off-by: Senthilnathan <cendhu@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type of change
Description
Set up MkDocs with Material theme to publish project documentation
on GitHub Pages. Adds mkdocs.yml configuration, a custom landing page
(docs/index.md), a GitHub Actions workflow to deploy on push to main,
and a CI check to validate the docs build on pull requests.
Related issues