GithubHelp home page GithubHelp logo

Comments (9)

pavanpodila avatar pavanpodila commented on May 19, 2024 1

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 :-)

from mobx.dart.

pavanpodila avatar pavanpodila commented on May 19, 2024

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

from mobx.dart.

chimon2000 avatar chimon2000 commented on May 19, 2024

Would the site be in this repo or elsewhere?

from mobx.dart.

chimon2000 avatar chimon2000 commented on May 19, 2024

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.

from mobx.dart.

rrousselGit avatar rrousselGit commented on May 19, 2024

FWIW docs.flutter.io is actually generated from dartdoc

from mobx.dart.

chimon2000 avatar chimon2000 commented on May 19, 2024

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.

from mobx.dart.

chimon2000 avatar chimon2000 commented on May 19, 2024

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

from mobx.dart.

pavanpodila avatar pavanpodila commented on May 19, 2024

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

from mobx.dart.

chimon2000 avatar chimon2000 commented on May 19, 2024

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

from mobx.dart.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.