Repository navigation
doc: fence code blocks #4726
Description
Activity
It's docs, churn doesn't exist like that imo
I agree. Also it's clearer while editing the docs for the eye, imo, and for markdown syntax highlighters. I'd offer some time to do it. Are there any blockers?
I'd say go for it. One thing that needs to be checked beforehand is that the HTML output of
make docis showing correctly highlighted code blocks with the fences in place.Alright. Will likely send in feedback today.
@silverwind I added three commits. The code block change is really big of course. I wanted to take some time on a bigger screen to review it tomorrow. I am pretty sure everything is alright though. Do have a look at the commit message for known issues.
I also added one to rename
.markdownfiles, which has implications ontoolsand themakefile. Please do regard this as optional. I think the only reason no-one has changed this, is because it requires the change in 4 places.@silverwind if you like, do have a look at Rods remarks on the PR. If you want to take this further, I am happy to change stuff accordingly.
- added a commit that references this issue
on Jan 25, 2016 - added 2 commits that reference this issue
on Feb 22, 2016 - added a commit that references this issue
on Mar 2, 2016 - added a commit that references this issue
on Apr 2, 2016 - added a commit that references this issue
on Jul 27, 2026
Currently, we use 4-space indent to mark code blocks in the docs. It'd be better if we could replace them with backtick fences like
js` orc++`. This has two benefits:Because this would be another "churn" commit, I'd like to ask for opinions first.