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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup Mkdocs website for documentation #722

Merged
merged 6 commits into from Jul 5, 2019

Conversation

ShaishavGandhi
Copy link
Collaborator

Inspired by OkHttp!

This sets up a nice website for documentation as well as API docs. Here's what it essentially looks like in my fork: https://shaishavgandhi.github.io/kotlinpoet/

Feel free to suggest other colors 馃槄

@jeremy-techson
Copy link

@ShaishavGandhi Is it possible to update the icon?

image

@Egorand
Copy link
Collaborator

Egorand commented Jul 5, 2019

THIS IS AWESOME!! Thanks a ton!

Can you please also add a custom CSS to use our fonts? square/okhttp@a56f483

@ShaishavGandhi
Copy link
Collaborator Author

Added the custom CSS!

@ShaishavGandhi Is it possible to update the icon?

I'm guessing OkHttp has the same problem? I didn't notice since I'm on dark mode on Mac. Happy to swap out it out for a black Square logo but I don't have the assets.

@Egorand
Copy link
Collaborator

Egorand commented Jul 5, 2019

Yeah, same, the icon looks good on dark tabs. Let's fix this in a followup.

@Egorand
Copy link
Collaborator

Egorand commented Jul 5, 2019

What are the deployment steps by the way?

@ShaishavGandhi
Copy link
Collaborator Author

Once it's merged, just run ./.buildscript deploy_website.sh and it should deploy the website under https://square.github.io

@Egorand
Copy link
Collaborator

Egorand commented Jul 5, 2019

Sweet, merging!

@Egorand Egorand merged commit 9dfab49 into square:master Jul 5, 2019
@ShaishavGandhi ShaishavGandhi deleted the sg/docs branch July 5, 2019 16:51
ShaishavGandhi added a commit to ShaishavGandhi/kotlinpoet that referenced this pull request Aug 14, 2019
* Add static site generation for KotlinPoet

* Add temporary branch

* Finalize deployment

* Remove copy of mkdocs.yml

* Clean up unnecessary bits

* Add Square font with custom css
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.

None yet

3 participants