Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add magidoc documentation #46

Merged
merged 14 commits into from
Sep 8, 2022
Merged

Conversation

pelletier197
Copy link
Contributor

@pelletier197 pelletier197 commented Aug 19, 2022

Added magidoc documentation. See the example output here: https://pelletier197.github.io/countries

Once merged, the documentation will automatically be deployed at https://trevorblades.github.io/countries

To simplify my life, I needed to extract the schema in a separate file. This is easier to get the schema for me, and will be simpler for you to add the comments.

  • For now, custom pages are empty. Only the generated documentation is shown. Feel free to add markdown pages if you want and move your examples in there. (See: https://magidoc.js.org/cli/magidoc-configuration#website)
  • Documentation is rebuilt and deployed at every merge on the main branch.

Thank you!

Resolve #45

@pelletier197
Copy link
Contributor Author

@trevorblades any chance you can check this ?

@trevorblades
Copy link
Owner

trevorblades commented Sep 8, 2022

Looking great @pelletier197! 🎉 I tested out the site using magidoc preview and it works well.

I made a branch with a bunch of changes that make the linter happy again. Could you add me as a contributor to your fork, and then I can make a PR there?

@pelletier197
Copy link
Contributor Author

Done @trevorblades 😃

@trevorblades trevorblades merged commit 2ced74c into trevorblades:main Sep 8, 2022
@trevorblades
Copy link
Owner

Thanks @pelletier197! 🍣 🍔 🌮

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposition: add static documentation
2 participants