Skip to content

Commit b87128d

Browse files
committed
docs: plainer living-example callout
1 parent 7252fae commit b87128d

1 file changed

Lines changed: 4 additions & 7 deletions

File tree

www-next-gen/how-tos/render-readme-as-doc-site.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,10 @@ let pages = ($readme | split row "\n## " | skip 1 | each {|s|
5151
Add a sidebar that lists the sections and you have navigation. The README stays
5252
the single source of truth; you just slice it.
5353

54-
> **A living example.** You do not have to imagine the result, you are reading
55-
> inside it. The [Reference](/reference) section of this site is the http-nu
56-
> README run through exactly the code above: one page per `## ` heading, a
57-
> sidebar built from the slugs, a prev/next pager. Go open it and click between
58-
> sections, watch the URL become each slug, then come back here, the code will
59-
> read like a description of what you just used. That is the whole lesson: the
60-
> doc site and the README are the same thing.
54+
> **A living example.** The [Reference](/reference) section of this site is the
55+
> code above, running: the http-nu README, sliced one page per `## ` heading,
56+
> with a sidebar of slugs and a prev/next pager. Click through it, then come
57+
> back here, the code reads like a description of what you just used.
6158
6259
## Typography
6360

0 commit comments

Comments
 (0)