Skip to content
This repository has been archived by the owner on Sep 13, 2023. It is now read-only.

Replace examples with guides! #24

Merged
merged 4 commits into from Jan 27, 2018
Merged

Replace examples with guides! #24

merged 4 commits into from Jan 27, 2018

Conversation

killercup
Copy link
Owner

@killercup killercup commented Jan 26, 2018

Also adds testing on CI. Rending this in some way other than on github.com will come at a later point.

TODO

Required to land this

  • Set up waltz on Travis
  • Move over Readme guide
  • Move over commit guide

Stretch goals

  • Cache target dir between crates generated waltz
  • Set up github pages rendering with simple template
  • Move over image resize guide from Use case: resize image #23

cc #16

@killercup
Copy link
Owner Author

What do you think, @vitiral?

I'm not sure about moving the getting started guide out of the readme, but otherwise I think this is quite a good format that mixes guide and recipe style.

@vitiral
Copy link
Contributor

vitiral commented Jan 26, 2018

This is really cool! I'm working on getting ergo_fs pushed now, will definitely eventually incorporate this kind of "book style" into ergo.

@killercup
Copy link
Owner Author

Glad you like it @vitiral!

I'll try to have some time to get a simple github pages setup going. Ideally, it'll use a custom (but external) theme, so it should be only a matter of adding two or three files to get a nice rendered version of website with these guides.

@killercup
Copy link
Owner Author

Alright, Jekyll with custom theme set up! I still need to configure this once it is in master to render, though.

You can find the theme I wrote in https://github.com/killercup/jekyll-theme-rustguides. I haven't spend much time writing CSS for this, but I did make it possible to customize the main color. For quicli, I chose dark blue (at random, basically). The layout is quite barebones right now. It has a list of pages (currently just the one for the commit.md guide), but there is not footer or anything like that.

bildschirmfoto 2018-01-27 um 19 17 31

I think I'll land this tonight, because I won't have much time to work on this for the next week. Feedback (now or later) is very welcome! :)

@killercup killercup merged commit a1bfb89 into master Jan 27, 2018
@killercup killercup deleted the add-guides branch January 30, 2018 10:34
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants