feat(gnoweb): rework & Implement new gnoweb design #3195

gfanton · 2024-11-25T18:51:17Z

address #3191

Reworking the gnoweb package:

Implement gnoweb new interface design(cc @alexiscolin).
Move Markdown rendering to the server to enhance speed and security. This change also simplifies the implementation of new components, making it more standardized as a Go library.
Aim to keep dependencies minimal, using only goldmark for Markdown and chroma for code highlighting, with almost no (in)direct dependencies.
Transition to Tailwind for simplicity and maintainability.
Retain all features from the previous gnoweb iteration.

Preview

Home
Source
Docs

TODO:

port and adapt all previous tests to ensure compatibility (it should not take too long)
Some cleanup and restructuring + linting.

Signed-off-by: gfanton <[email protected]>

Gno2D2 · 2024-12-03T06:47:23Z

🛠 PR Checks Summary

🔴 The pull request head branch must be up-to-date with its base (more info)

Manual Checks (for Reviewers):

SKIP: Do not block the CI for this PR
Determine if infra needs to be updated before merging

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🔴 The pull request head branch must be up-to-date with its base (more info)

☑️ Contributor Actions:

Fix any issues flagged by automated checks.
Follow the Contributor Checklist to ensure your PR is ready for review.
- Add new tests, or document why they are unnecessary.
- Provide clear examples/screenshots, if necessary.
- Update documentation, if required.
- Ensure no breaking changes, or include BREAKING CHANGE notes.
- Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

Debug

Automated Checks

Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: gfanton/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

The pull request head branch must be up-to-date with its base (more info)

If

🟢 Condition met
└── 🟢 On every pull request

Then

🔴 Requirement not satisfied
└── 🔴 Head branch (gfanton:feat/gnoweb-rework) is up to date with base (master): behind by 16 / ahead by 74

Manual Checks

**SKIP**: Do not block the CI for this PR

If
🟢 Condition met
└── 🟢 On every pull request
Can be checked by

Any user with comment edit permission

Determine if infra needs to be updated before merging

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: master
    └── 🟢 Or
        ├── 🔴 A changed file matches this pattern: Dockerfile
        ├── 🟢 A changed file matches this pattern: ^misc/deployments (filename: misc/deployments/staging.gno.land/docker-compose.yml)
        ├── 🔴 A changed file matches this pattern: ^misc/docker-
        ├── 🔴 A changed file matches this pattern: ^.github/workflows/releaser.*\.yml$
        └── 🔴 A changed file matches this pattern: ^.github/workflows/portal-loop\.yml$

Can be checked by

team devops

Signed-off-by: gfanton <[email protected]>

gno.land/pkg/gnoweb/app.go

gno.land/pkg/gnoweb/alias.go

…/gnoweb-rework

thehowl

pr on fork incoming

thehowl · 2024-12-09T10:59:54Z

gno.land/cmd/gnoweb/main.go

+	bind       string
+	analytics  bool
+	json       bool
+	html       bool


why have this as an option?

Keeping the original behaviors of gnoweb, it has also been added recently to gnodev by @moul, so I believe we still need to keep this around as an option.

thehowl · 2024-12-09T11:03:35Z

gno.land/pkg/gnoweb/Makefile

Can we have a README, not something too long / complex, but which can help me (or anyone else) quickly answer how to do changes and generally develop on gnoweb?

yes definitely

thehowl · 2024-12-09T12:28:42Z

gno.land/pkg/gnoweb/app.go

+	assetsBase := "/" + strings.Trim(cfg.AssetsPath, "/") + "/"
+
+	// Handle assets path
+	mux.Handle(assetsBase, AssetHandler(true))


Should be a way to configure this, maybe from gnoweb or using a build tag, for local development

gno.land/pkg/gnoweb/handler.go

thehowl · 2024-12-09T14:09:46Z

gno.land/pkg/markdown/toc.go

after discussion, think this should be gno.land/pkg/gnoweb/markdown

we can move to be more generic in the future and then to gno.land/pkg/markdown, but i suggest you focus on the specific case for now

thehowl · 2024-12-09T16:10:49Z

gno.land/pkg/gnoweb/handler.go

General comment: we never set a page title anywhere. Can we configure page titles? :)

(I mean the <title> head tag in HTML)

thehowl · 2024-12-09T16:13:28Z

other general comment, but I'm sure you thought about it:

it would be cool if the "search bar" (where the realm path is) acted kind of as a "command palette", and as such allowed to move quickly to help and source, and to move to other realms.

I imagine this is somewhat envisioned/planned. I'm looking forward :)

misc minor fixes and changes

leohhhn · 2024-12-10T16:13:06Z

Just another design point @alexiscolin
I think the italic is a bit too italic,
and I think the margin/padding of the codeblocks might be a bit too large. WDYT?

Signed-off-by: gfanton <[email protected]>

moul · 2024-12-10T16:48:42Z

contribs/gnodev/cmd/gnodev/setup_web.go

 	"log/slog"
 	"net/http"

 	gnodev "github.com/gnolang/gno/contribs/gnodev/pkg/dev"
-	"github.com/gnolang/gno/gno.land/pkg/gnoweb"
+	gnoweb "github.com/gnolang/gno/gno.land/pkg/gnoweb"


Suggested change

gnoweb "github.com/gnolang/gno/gno.land/pkg/gnoweb"

"github.com/gnolang/gno/gno.land/pkg/gnoweb"

moul · 2024-12-10T16:53:05Z

gno.land/cmd/gnoweb/README.md

@@ -1,13 +0,0 @@
-# gnoweb


Keep a README in this folder, but feel free to remove the "install" part and only mention that people can view previews on gno.land or run it with gnodev, linking to the gnodev folder.

moul · 2024-12-10T16:55:30Z

gno.land/cmd/gnoweb/main_test.go

@@ -1,14 +0,0 @@
-package main


Please keep it this way: 1. to facilitate the addition of second tests later, and 2. to ensure that go test does not skip this folder and passes the basic syntax checks.

moul · 2024-12-10T16:58:59Z

gno.land/pkg/gnoweb/components/breadcrumb.gohtml

@@ -0,0 +1,12 @@
+{{ define "breadcrumb" }}


Can we consider not committing those generated files (and gitignore them) and ensure that each install command runs go generate?

thehowl · 2024-12-10T17:00:31Z

gno.land/pkg/gnoweb/Makefile

+	go install -v .
+
+# Generate process
+generate: clean css ts fonts


should have a CI workflow to ensure it's always up-to-date

leohhhn · 2024-12-10T17:53:45Z

@alexiscolin another small bug; with ordered lists the number does not show up:

Signed-off-by: gfanton <[email protected]>

sw360cab · 2024-12-11T09:22:12Z

misc/deployments/staging.gno.land/docker-compose.yml

Since faucet config is removed from config, would it not be accessible from Gnoweb anymore?
Which is the entrypoint of Faucet so far? Because CAPTCHA_SITE_KEY is not set anywhere else, and is the one intended to be used by a Gnofaucet frontend.

cc: @zivkovicmilos

Signed-off-by: gfanton <[email protected]>

gfanton added 11 commits November 25, 2024 18:27

wip: rework gnoweb

af2112b

Signed-off-by: gfanton <[email protected]>

wip: create gnoweb app, sync gnodev with gnoweb

f4f3a86

Signed-off-by: gfanton <[email protected]>

chore: cleanup

f3dbbf3

Signed-off-by: gfanton <[email protected]>

wip: re-add status json page

5dd673d

Signed-off-by: gfanton <[email protected]>

chore: cleanup

997ab46

Signed-off-by: gfanton <[email protected]>

chore: clenaup

a112a63

Signed-off-by: gfanton <[email protected]>

fix: height

5e13369

Signed-off-by: gfanton <[email protected]>

feat: rework gnoweb

a97d66d

Signed-off-by: gfanton <[email protected]>

chore: cleanup

e53bbb4

Signed-off-by: gfanton <[email protected]>

chore: cleanup

611e315

Signed-off-by: gfanton <[email protected]>

chore: cleanup

2eaee06

Signed-off-by: gfanton <[email protected]>

gfanton requested a review from alexiscolin November 25, 2024 18:51

gfanton assigned alexiscolin and gfanton Nov 25, 2024

github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Nov 25, 2024

alexiscolin added the 🌍 gnoweb Issues & PRs related to gnoweb and render label Nov 26, 2024

Kouteki added the in focus Core team is prioritizing this work label Nov 27, 2024

zivkovicmilos self-requested a review November 29, 2024 03:42

leohhhn linked an issue Nov 30, 2024 that may be closed by this pull request

[gnoweb] Display line numbers on package & realm source code renders #1875

Open

alexiscolin mentioned this pull request Dec 2, 2024

[META] Update of Gnoweb for a User-Centric Experience #3191

Open

chore: telemetry link

550055e

alexiscolin and others added 2 commits December 3, 2024 16:11

fix: fonts url

3f4a4bb

wip: source files

60243f6

Signed-off-by: gfanton <[email protected]>

leohhhn self-requested a review December 3, 2024 16:35

leohhhn reviewed Dec 3, 2024

View reviewed changes

gno.land/pkg/gnoweb/app.go Outdated Show resolved Hide resolved

gno.land/pkg/gnoweb/alias.go Outdated Show resolved Hide resolved

alexiscolin added 4 commits December 4, 2024 15:59

feat: enable copy btn

d08528b

Merge branch 'feat/gnoweb-rework' of github.com:gfanton/gno into feat…

7c48c36

…/gnoweb-rework

chore: clean logs

f7d708a

feat: copy feedback

f6687ed

thehowl added 11 commits December 9, 2024 13:38

create per-test cfg/logger

f0bde45

formater -> formatter

2e9f3cb

DefaultHost -> DefaultChainDomain

4c3f6a1

ChainID typo fix

3445f52

remove unused KindUser

b93ae3d

change Kind to method

d3a0af7

simplify regex

203c5fe

took -> elapsed

d4d8645

ChainId -> ChainID

28dac08

remove empty send

bc52d9b

some renaming

d97f08f

thehowl approved these changes Dec 9, 2024

View reviewed changes

thehowl reviewed Dec 9, 2024

View reviewed changes

thehowl mentioned this pull request Dec 9, 2024

rfc: gno doc command #522

Open

Merge pull request #16 from thehowl/dev/morgan/gnoweb-rework-pr

949e90b

misc minor fixes and changes

fix: remove buffer pool

db88955

Signed-off-by: gfanton <[email protected]>

moul reviewed Dec 10, 2024

View reviewed changes

thehowl reviewed Dec 10, 2024

View reviewed changes

gfanton and others added 2 commits December 11, 2024 08:43

fix: deadcode

9e90280

Signed-off-by: gfanton <[email protected]>

style: update italic and list

ac19ef6

sw360cab reviewed Dec 11, 2024

View reviewed changes

gfanton added 3 commits December 11, 2024 18:11

fix: add main test to actually test the setup

cbd3cd9

Signed-off-by: gfanton <[email protected]>

chore: lint

db59650

Signed-off-by: gfanton <[email protected]>

chore: add minimal readme

4b1dd8a

Signed-off-by: gfanton <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(gnoweb): rework & Implement new gnoweb design #3195

feat(gnoweb): rework & Implement new gnoweb design #3195

gfanton commented Nov 25, 2024 •

edited

Loading

Gno2D2 commented Dec 3, 2024 •

edited

Loading

✅ Automated Checks (for Contributors):

☑️ Contributor Actions:

☑️ Reviewer Actions:

📚 Resources:

If

Then

If

Then

If

Can be checked by

If

Can be checked by

thehowl left a comment

thehowl Dec 9, 2024

gfanton Dec 11, 2024

thehowl Dec 9, 2024

gfanton Dec 11, 2024

thehowl Dec 9, 2024

thehowl Dec 9, 2024

thehowl Dec 9, 2024

thehowl Dec 9, 2024

thehowl commented Dec 9, 2024

leohhhn commented Dec 10, 2024

moul Dec 10, 2024 •

edited

Loading

moul Dec 10, 2024 •

edited

Loading

moul Dec 10, 2024

moul Dec 10, 2024 •

edited

Loading

thehowl Dec 10, 2024

leohhhn commented Dec 10, 2024 •

edited

Loading

sw360cab Dec 11, 2024

	gnoweb "github.com/gnolang/gno/gno.land/pkg/gnoweb"
	"github.com/gnolang/gno/gno.land/pkg/gnoweb"

feat(gnoweb): rework & Implement new gnoweb design #3195

Are you sure you want to change the base?

feat(gnoweb): rework & Implement new gnoweb design #3195

Conversation

gfanton commented Nov 25, 2024 • edited Loading

Preview

TODO:

Gno2D2 commented Dec 3, 2024 • edited Loading

🛠 PR Checks Summary

Manual Checks (for Reviewers):

✅ Automated Checks (for Contributors):

☑️ Contributor Actions:

☑️ Reviewer Actions:

📚 Resources:

If

Then

If

Then

If

Can be checked by

If

Can be checked by

thehowl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thehowl commented Dec 9, 2024

leohhhn commented Dec 10, 2024

moul Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

moul Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moul Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leohhhn commented Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

gfanton commented Nov 25, 2024 •

edited

Loading

Gno2D2 commented Dec 3, 2024 •

edited

Loading

moul Dec 10, 2024 •

edited

Loading

moul Dec 10, 2024 •

edited

Loading

moul Dec 10, 2024 •

edited

Loading

leohhhn commented Dec 10, 2024 •

edited

Loading