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

Build a slick website showcasing the power of mobx.dart #21

Closed
pavanpodila opened this issue Jan 7, 2019 · 9 comments · Fixed by #71
Closed

Build a slick website showcasing the power of mobx.dart #21

pavanpodila opened this issue Jan 7, 2019 · 9 comments · Fixed by #71
Labels
help wanted Extra attention is needed
Milestone

Comments

@pavanpodila
Copy link
Member

This is the marketing site + docs. I am thinking a site in Gatsby would be good and easy to maintain over time.

@pavanpodila pavanpodila added the help wanted Extra attention is needed label Jan 7, 2019
@pavanpodila
Copy link
Member Author

This is also a good time to revisit the logo, if needed

@chimon2000
Copy link
Collaborator

Would the site be in this repo or elsewhere?

@chimon2000
Copy link
Collaborator

As an alternative to Gatsby, have you looked at Docsify?

It's obviously not as popular, but it offers some of the same benefits and it's focused specifically on documentation.

@rrousselGit
Copy link
Collaborator

FWIW docs.flutter.io is actually generated from dartdoc

@chimon2000
Copy link
Collaborator

chimon2000 commented Jan 16, 2019

Also important to note that flutter.io uses Jekyll.

dartdoc seems like a good candidate if the idea is to maintain a consistent stack, generate documentation from comments, and minimize customization.

With the other options mentioned, documentation becomes a bit more explicit. On the flipside, classes can potentially become quite large when filled with examples & documentation.

@chimon2000
Copy link
Collaborator

@pavanpodila

I have been building a site based off of the README updates, take a look at what I have so far:

https://well-cruiser.glitch.me/

Important things to note here is that this is 100% generated from README's so there is no need to fudge with any extra technologies (Gatsby, Vuepress, Docusaurus, etc.)

@pavanpodila
Copy link
Member Author

@chimon2000 This looks great! Can we do any tweaks in theming and formatting?

@chimon2000
Copy link
Collaborator

Yes. I have not played around with the styling too much but it shouldn't be terribly hard. I will submit a PR.

The default styling is based off Medium.css

@pavanpodila
Copy link
Member Author

BTW, I am also very tempted to try out Docz. It's still markdown, so we can reuse most of the README.md files. Let me know if you want to give that a shot :-)

This was referenced Jan 29, 2019
@pavanpodila pavanpodila added this to the v0.1 milestone Feb 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants