Skip to content

docs: fix markdown docs#3459

Merged
bartlomieju merged 7 commits into
freshframework:mainfrom
fry69:fry69/docs-fix-markdown
Mar 29, 2026
Merged

docs: fix markdown docs#3459
bartlomieju merged 7 commits into
freshframework:mainfrom
fry69:fry69/docs-fix-markdown

Conversation

@fry69

@fry69 fry69 commented Sep 17, 2025

Copy link
Copy Markdown
Contributor

This fixes the markdown docs.

Notes:

Comment thread docs/latest/examples/markdown.md Outdated

1. Run `deno install jsr:@deno/gfm`
2. Create a markdown file like `content.md`:
1. Run `deno install --allow-scripts jsr:@deno/gfm`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit JSR packages don't have postinstall scripts like npm. The --allow-scripts flag does nothing here.

@fry69 fry69 Sep 19, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, but I try to align to docs to a freshly installed demo app with @fresh/init. When I run that command without --allow-scripts, I get warnings about scripts for Tailwind, at least. Also the Vite script seems to run for the first time when run with --allow-scripts, so I almost habitually include that everywhere now.

I'll remove that option.

@bartlomieju

Copy link
Copy Markdown
Contributor

A couple of things I noticed:

  • route/markdown.tsx should be routes/markdown.tsx — Fresh uses the plural routes/ directory. The ../utils.ts import also depends on this being correct.
  • External tutorial link — the link to jackfiszr.eu is a third-party blog that could go stale. Worth considering whether the team wants to maintain external links in the official docs, or if just pointing to the www/ source code is sufficient.

- Use define.page() in a route file instead of old App/ctx.render API
- Use @/utils.ts import consistent with other examples
- Fix route path to routes/markdown.tsx
- Use inline lint-ignore comments instead of file-level directive
- Remove external tutorial link (could go stale)
- Fix step numbering (was skipping step 3)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@bartlomieju bartlomieju enabled auto-merge (squash) March 29, 2026 19:08
@bartlomieju bartlomieju merged commit ad8ec0f into freshframework:main Mar 29, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants