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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make this a pretty website #6

Open
nrc opened this issue Apr 3, 2015 · 7 comments
Open

Make this a pretty website #6

nrc opened this issue Apr 3, 2015 · 7 comments

Comments

@nrc
Copy link
Owner

nrc commented Apr 3, 2015

With a URL and rendered pages, rather than a plain GH repo. I believe GH or someone else provides some tools for this (gitbook?) so it shouldn't be too hard

@anuragsoni
Copy link
Contributor

Gitbook can be a way, also you Jekyll might a decent enough option and its really well integrated with github out of the box. I've used Jekyll for simple coding-related blogs before and was happy with the results.

@liamsi
Copy link
Contributor

liamsi commented Apr 8, 2015

I think Jekyll is the way to go, if this supposed to look more like a blog.
Gitbook seems like a better option if this is supposed to look more like a book. What would you prefer?
I'm going to look at both options myself the next days/weeks. I could take care of this issue.

@nrc
Copy link
Owner Author

nrc commented Apr 8, 2015

I think Jekyll looks like a good option - I'm not really sure how to decide between that and gitbook, but Jekyll looks the least invasive (I'm keen to keep r4cppp browsable as markdown) and good enough, feature-wise.

Would be great if you could look at this!

@killercup
Copy link

@nrc I just tried this locally: Making this a "gitbook" is just a matter of adding a Summary.md (that contains pretty much the same as https://github.com/nrc/r4cppp#contents). It looks pretty nice.

Gitbook itself can be installed with npm install --global gitbook, and then does some magic when you call gitbook serve (e.g.) in the r4cppp folder. I'm not sure how this integrates with gitbook.com though; it seems they offer hooks for github so that it gets published on their site automatically. You can probably also just let travis render and upload this (like rustdoc output).

@liamsi
Copy link
Contributor

liamsi commented Apr 13, 2015

Locally it worked like a charm for me, too (using gitbook build/gitbook serve). Though linking to my fork, their webinterface created a file called SUMMARY..md instead of SUMMARY.md (maybe a bug?).
As @killercup pointed out, gitbook isn't invasive either. Basically you need this files: http://help.gitbook.com/format/index.html

Either way, it would be better to switch to relative links between (internal) md files (https://help.github.com/articles/relative-links-in-readmes/). I am sure this would be of benefit for both solutions (jekyll/gitbook or even other static site generators).

@nrc
Copy link
Owner Author

nrc commented Apr 13, 2015

Thanks for checking this out @killercup and @liamsi! I filed #23 about the relative links, that does sound like something we should do.

@liamsi
Copy link
Contributor

liamsi commented May 23, 2015

I'm not sure if already saw it: https://www.gitbook.com/book/aminb/rust-for-c/details
It is the first hit on google search: c++ programmers about rust

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

No branches or pull requests

4 participants