Repository navigation
Add a VitePress documentation site generated from the README - #30
Merged
Merged
Conversation
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
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.
Adds a documentation site under
docs/, built with VitePress and deployed to GitHub Pages.docs/scripts/gen.mjssplitsREADME.mdinto nine guide pages at build time and rewrites the links between sections. The README itself is unchanged. If a README heading named in the script is renamed, the build fails and says which one.docs/index.md, written by hand.assets/as the logo..github/workflows/docs.yamlbuilds and deploys on pushes tomainthat touchdocs/,README.mdorassets/.Before the first deployment
GitHub Pages has to be enabled in the repository settings with GitHub Actions as the source. The site will be served at https://mysticmind.github.io/pgsqlparser-dotnet/.
Running it locally
cd docs npm install npm run dev