Giter Site home page Giter Site logo

Comments (11)

ffmiruz avatar ffmiruz commented on August 20, 2024 3

Index would be nice.
Also bigger font maybe. Matching the font at https://golang.org/pkg/ (Roboto 16px, 1.3em line height)

from golds.

nikolaydubina avatar nikolaydubina commented on August 20, 2024 1

I actually like this style more! It is good to have some alternative to godoc! Albeit, lately pkg.go.dev is just outstanding, something like it would be amazing.

from golds.

3052 avatar 3052 commented on August 20, 2024 1

too much effort. I will just continue to use Doc2Go

from golds.

zigo101 avatar zigo101 commented on August 20, 2024

Do you mean many people expect that the docs of methods should be all expanded initially?

from golds.

SVilgelm avatar SVilgelm commented on August 20, 2024

I mean many people are already familiar with the style, that godoc or pkg.go.doc use, and they expected something similar

from golds.

zigo101 avatar zigo101 commented on August 20, 2024

It is hard to make their styles very alike, for godoc provides much less information for types than golds. In fact, godoc only lists methods as the only property of types. (Whereas golds lists fields, asOutputsOfFunctions, asInputsOfFunctions and asTypesOfValues as well.)

One the other hand, they could be more similar later than now in some extend. The things I can think of may be made to increase the similarity are:

  • add an index section
  • always expand the current collapsed content
  • show code examples

Do you think these will help? Or do you have any other ideas to increase the similarity?

from golds.

zigo101 avatar zigo101 commented on August 20, 2024

v0.2.0 is released with some UE adjustments and several small new features.

from golds.

3052 avatar 3052 commented on August 20, 2024

this is not exactly the old style, but its much similar than the current Golds incarnation:

https://github.com/abhinav/doc2go

from golds.

zigo101 avatar zigo101 commented on August 20, 2024

@3052
I admit Golds is still far to perfection, but Golds has too many differences from godoc
that it is hard to make their UI style very similar.

Golds was mainly developed for my own need: study some Go projects by reading their code.
Generating package public APIs is more a by-product.

For lack of enough spare time and I don't see a bright future for Go any more,
I will spend much less time on this project, especially on adjusting the UI style.
I'm sorry for this. Everybody can fork this project to make changes according their needs.

from golds.

3052 avatar 3052 commented on August 20, 2024

For lack of enough spare time and I don't see a bright future for Go any more,
I will spend much less time on this project, especially on adjusting the UI style.

in that case, make me owner of https://github.com/go101/golds, and I can address the issues

from golds.

zigo101 avatar zigo101 commented on August 20, 2024

You can fork it and do whatever you want. :)

from golds.

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.