writefreely / writefreely/documentation

You doc is not a good example ;-) [syntax highlighting isn't]

Open
#48 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
18
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Describe the bug

https://writefreely.org/docs/v0.13.2/writer/writing.md

Section Syntax-highlighted Code Blocks.

It doesn't. :-)

Looks like three-backticks-go isn't quite interpreted, or you forgot closing three-backticks?

Expected behavior

Probably rendering a syntax highlighten source code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked writing.md page and inspect the “Syntax-highlighted Code Blocks” section, starting with how the three-backtick example is written. Confirm that the example renders as a syntax-highlighted source block, rather than displaying unhighlighted or malformed markup.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.