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

One tip per file #13

Closed
eggcaker opened this issue Jan 2, 2016 · 21 comments
Closed

One tip per file #13

eggcaker opened this issue Jan 2, 2016 · 21 comments

Comments

@eggcaker
Copy link

eggcaker commented Jan 2, 2016

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 .

@loverajoel
Copy link
Owner

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 like the idea of all tips in the same file, because it's easy to read, but yes maybe the readme can be a index and each tip in separate files.

I think that the files should be named #N - title -> 01 - AngularJs: $digest vs $apply

@eggcaker
Copy link
Author

eggcaker commented Jan 2, 2016

kind of, like a blog entry #date #N #tags title more for seach and read in the future.

@primozs
Copy link

primozs commented Jan 3, 2016

Maybe post on a static site with rss.

@macx
Copy link

macx commented Jan 3, 2016

@primozs +1

@loverajoel
Copy link
Owner

I'm thinking use jekyll-now when the amount of tips grow

@eknowles
Copy link

eknowles commented Jan 4, 2016

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.

@loverajoel
Copy link
Owner

@eknowles sure I will try it, thanks

@cgmartin
Copy link

cgmartin commented Jan 5, 2016

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/

@mallowigi
Copy link
Contributor

+1

@hemanth
Copy link

hemanth commented Jan 8, 2016

You could use doxie, like what git-tips does.

@pklinger
Copy link
Contributor

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 ...

@hueitan
Copy link

hueitan commented Jan 15, 2016

jstips(current/free way) can give more details on the section.
doxie is given only predefined structure.

@drakmail
Copy link
Contributor

👍 for one tip per file

@pmuens
Copy link

pmuens commented Jan 15, 2016

👍 Really like the RSS idea. So that one can subscribe to the feed and get a new tip delivered every day!

@drakmail
Copy link
Contributor

@pmuens also, you can subscribe to email subscription or use auto generated RSS feed (can be rendered with issues in some RSS clients)

@tylerdmace
Copy link

+1 The sooner this gets implemented, the better!

@AdriVanHoudt
Copy link

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

@drakmail
Copy link
Contributor

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

@pmuens
Copy link

pmuens commented Jan 19, 2016

@drakmail thanks for the links!

@mrosata
Copy link

mrosata commented Jan 20, 2016

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?

@loverajoel
Copy link
Owner

Hi guys, I'm working in the theme for jekyll in this branch and the beta is live in tipsjs.co.
After debug and review the site I have in mind change the branch gh-page how master of this repo.
Now there are one tip per file and a TOP in the readme.

Feedback are welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests