Comments (3)
This is an interesting UE design.
I will add a todo list for this, but I'm afraid that I will have not enough time to implemented it in a near future version.
And content richness is not now (edited) viewed more important than UI/UE at the current phase.
Thanks for the suggestion.
from golds.
Thank you for considering it for future.
I had an itch and wanted to take a stab to see how it'd look with golds, so I did some quick hack to incorporate literate style source view.
- Here's the commit in my fork: mugli@4375841
- Here's how a page looks now: https://mugli.github.io/tmp-literate-golds/src/golang.org/x/pkgsite/internal/auth/auth.go.html
There are some edge cases that are not handled yet. For example, a lot of time comments contain example code. Those currently looks broken in this structure. Also, Go directives are not handled separately from regular comments.
Feature wise, markdown in comment is not handled yet. It might be useful if someone wants to annotate the code.
If you think it can be merged with some tweaks, I can prepare a PR if you want. But I certainly understand it's not a priority now, so totally fine if you don't want that at this moment. I'll try to maintain the fork as long as I'm using this feature.
from golds.
Aha, you have made some tweaks on the Golds projects.
That is really cool. The code base of Golds has not been cleaned yet.
Some parts of it might be hard to understand.
Yes, I couldn't merge the PR now. It is quality unrelated.
It is just because the change is some big.
Markdown renderer is a good idea but it looks markdown is not used popularly for documents in Go world.
But it is really a good idea to recommend people to use markdown in documents.
Do you think it is okay to implement the whole feature mainly in JS at client side?
from golds.
Related Issues (20)
- Incorrect file names of generated HTML files HOT 3
- panic: writeExternalSourceCodeLink error: buildExternelSourceLink: source file github.com/PagerDuty^9f750/go-pagerduty/client.go not found HOT 6
- Allow passing a list of packages to be included HOT 6
- Golds v0.4.2 does not find go files HOT 19
- Escaping HTML tags HOT 2
- Panic with cold mod cache HOT 1
- Support Go 1.19 godoc formatting HOT 7
- panic with 0.5.0 HOT 1
- cannot get/install on go 1.17 HOT 1
- Selectors not collected from embedding instantiated types HOT 1
- Support dark theme HOT 3
- On Windows, fail to auto choose server port if the preferred port is used. HOT 1
- it doesn't seem to see submodules HOT 7
- Panic with Go 1.20.3 HOT 13
- Panic with go 1.21 HOT 4
- footer option doesn't work HOT 1
- Feature request: skip standard packages HOT 3
- expand all
- panic: should not HOT 3
- Show version tag of package? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from golds.