-
-
Notifications
You must be signed in to change notification settings - Fork 3
mdBook documentation #115
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
base: master
Are you sure you want to change the base?
mdBook documentation #115
Conversation
|
There is a GitHub actions workflow for mdBook and GitHub pages https://github.com/Insprill/dv-mapify/actions/new?category=none&query=mdbook |
|
i got it to work with GitHub Pages: https://t0stiman.github.io/dv-mapify/ |
.gitignore
Outdated
| !PackageBuilder/Assets/Mapify.meta | ||
| PackageBuilder/Assets/Mapify/Scripts/* | ||
| !PackageBuilder/Assets/Mapify/Scripts/*meta | ||
| PackageBuilder/Assets/Mapify/Scripts/*.dll |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why were some of these moved to a dedicated .gitignore and some aren't? These changes should be moved to a separate PR so it doesn't block this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea was to have PackageBuilder/.gitignore be a pure, unchanged Unity gitignore file and specify our own additions in the main gitignore.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can move the lines concerning PackageBuilder into PackageBuilder/.gitignore if you want?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I think that makes sense.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done

I saw your comment about switching to mdBook, and I thought why not give it a go. I updated the documentation for building the documentation as well.
For hosting the generated html files, i suggest github pages because it's free and easy.