-
Notifications
You must be signed in to change notification settings - Fork 804
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
One tip per file #13
Comments
Hey @eggcaker, yes, this is a good idea, I know that when the list of tips will grow up will be difficult to read. I think that the files should be named |
kind of, like a blog entry |
Maybe post on a static site with rss. |
@primozs +1 |
I'm thinking use jekyll-now when the amount of tips grow |
Can I suggest using Wintersmith? https://github.com/jnordberg/wintersmith If you've used jekyll it'll be very familiar. We can have a script that auto populates the author, contributors and have the build files on the gh-pages branch. |
@eknowles sure I will try it, thanks |
Since on the topic of static generators, a good leaderboard of the top open-source projects to choose from (can filter by JS) https://www.staticgen.com/ |
+1 |
You could use |
I also want to throw in, that using resources like images could be nice for some tips. Therefore, a nested folder structure could be useful for the future. At the moment, the project structure would be messed up pretty quickly if somebody wants to use image assets. Also, the loading speed of the single-page readme approach does not scale too well ... |
jstips(current/free way) can give more details on the section. |
👍 for one tip per file |
👍 Really like the RSS idea. So that one can subscribe to the feed and get a new tip delivered every day! |
@pmuens also, you can subscribe to email subscription or use auto generated RSS feed (can be rendered with issues in some RSS clients) |
+1 The sooner this gets implemented, the better! |
I liked how I could read through them, for the repo 1/file makes sense but then a website or something where they get bundled would be needed |
It not so hard just use something like Jekyll to convert it to nice blog format :) Btw I'm planning to setup jekyll on js2016.tips website |
@drakmail thanks for the links! |
I like the 1 tip idea. What about using https://readthedocs.org/ - I love how people write on Github, and I think it's smart because it allows comments and easy updating. With "read the docs" the files could still be hosted here but as the text grows it would also be organized, navigable and I don't know too much about "read the docs" but I know they use make to build the documentation so maybe that could be extended to output a single .md as well. Get the best of both worlds? |
How about keep one tip per file instead one page for all ?
In the future can do view tips like tldr ? can generate the one page tips with each tip .
The text was updated successfully, but these errors were encountered: