brillout / brillout/docpress

Overview pages

Open
#120 4 comments 0 reactions 0 assignees View on GitHub
enhancement :rocket:
Dominant language
TypeScript
Stars
14
Forks
7
Avg merge
14m
Merged PRs (30d)
3

Description

## nit

I like API reference pages. They provide good CTR and overview for the user. Example on current telefunc proto docs:
https://richard-unterberg.github.io/vike-docpress/api/

Image

Therefore a new Component was created for usage in mdx / tsx files:

```ts

```

this will spawn a responsive 2/x grid with the resolved values from the [headings.ts](https://github.com/richard-unterberg/vike-docpress/blob/master/packages/telefunc/lib/headings.ts)

WDYT @brillout

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the proposed usage in the issue and inspect the linked headings.ts file to understand how heading keys resolve. Clarify the intended scope and placement in docpress before implementing; done means the component renders the requested overview content in a responsive two-column grid.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.