Added initial documentation structure #40
Merged
Conversation
This file contains 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
✅ Deploy Preview for pxweb2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Added netlify badge in footer template
Added a workflow to build and deploy the documentation to GitHub Pages
Deploying pxweb2 with
|
| Latest commit: |
6d91806
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7d95f571.pxweb2.pages.dev |
| Branch Preview URL: | https://feature-docs.pxweb2.pages.dev |
| But you could always install it from source. | ||
|
|
||
| ### Install from source | ||
| Make usre that you have NodeJS installed. |
There was a problem hiding this comment.
Typo:
Suggested change
| Make usre that you have NodeJS installed. | |
| Make sure that you have NodeJS installed. | |
MikaelNordberg
requested changes
Apr 12, 2024
docs/overrides/partials/footer.html
Outdated
| <div class="md-footer-meta md-typeset"> | ||
| <div class="md-footer-meta__inner md-grid"> | ||
| {% include "partials/copyright.html" %} | ||
| <a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-accent.svg" alt="Deploys by Netlify" /> </a> |
There was a problem hiding this comment.
Will we use Netlify?
There was a problem hiding this comment.
God catch this was because we had to add this to be able to get an open source subscription from them. Will remove this
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added initial documentation structure that utilizes mkdocs with the material theme (https://squidfunk.github.io/mkdocs-material/)
You can run it localy with docker with the following command
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material