Add instructions for building project as part of an existing repository

just-the-docs / just-the-docs-template

one-click template to use just-the-docs on GitHub Pages

https://just-the-docs.github.io/just-the-docs-template/

MIT License

128 stars 109 forks source link

Add instructions for building project as part of an existing repository #16

Closed rtreddick closed 1 year ago

rtreddick commented 1 year ago

Per discussion 1183, I've updated the template docs to include the steps I took to get my site to build from my project's docs directory.

I create a section called "Hosting your docs from an existing project repo" in the project README detailing necessary modifications to the pages.yml file.
I linked to this new section near top of the README to redirect interested users
I linked to this new section from index.md

mattxwang commented 1 year ago

Thank you @rtreddick! I've been super swamped, so it's been a bit tricky for me to get to all the PRs. I'll optionally tag in @pdmosses, who wrote the original docs for this template README + homepage.

Regardless, I'll try to take a more in-depth look sometime this week. Thanks for your patience, and appreciate you submitting a PR!