-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Mkdocs setup #1392
Mkdocs setup #1392
Conversation
FYI out of band I've enabled GitHub Pages and added a CNAME record of:
|
Great, nice, sorry it took me some days to respond, can i help out also? |
Also noticed something: the pen editing button leads to a 404 page at the moment. |
@saintmalik What do you think of this PR? Reasonable enough as a first attempt? |
Yeah, its pretty awesome, and makes life easy for everyone |
Hint: if you use |
@kolyshkin yep I'm aware 😁 I realize the whole merge/rebase debate has a long history that I definitely don't want to engage in here. Suffice to say I'm in favor of adapting my preferences to what works for fellow contributors. Any chance you're up for opening a discussion if you'd like to see a rebase-centric set of workflows and norms? |
What type of PR is this?
What this PR does / why we need it:
Adds initial mkdocs material configuration and index doc so that a docs site may be hosted via GitHub Pages.
Which issue(s) this PR fixes:
Fixes #1343
Fixes #1380
Special notes for your reviewer:
There was some mention in #1343 about possibly using docusaurus, but I threw this together given that other maintainers are either already familiar with mkdocs or prefer it to docusaurus.