Paths

Table of Contentst

-
src/docs/user/userguide/
-
docs/
-
user/
-
userguide/
-
remarkup.diviner

Differential D25547

Diviner: Improve documentation for remarkup code blocks
ClosedPublic
Actions

Authored by 20after4 on Feb 29 2024, 17:33.

Tags

None

Referenced Files

	F4118532: D25547.1747019448.diff
	Sun, May 11, 03:10

	F4117491: D25547.1746993148.diff
	Sat, May 10, 19:52

	F4068688: D25547.1746808188.diff
	Thu, May 8, 16:29

	F4046111: D25547.1746737130.diff
	Wed, May 7, 20:45

	F4042721: D25547.1746725592.diff
	Wed, May 7, 17:33

	F4042720: D25547.1746725591.diff
	Wed, May 7, 17:33

	F4042719: D25547.1746725590.diff
	Wed, May 7, 17:33

	F4011313: D25547.1746625792.diff
	Tue, May 6, 13:49

View All 73 Files

Subscribers

Details

Reviewers

valerio.bozzolan

Group Reviewers

O1: Blessed Committers

Commits

rP32b5139d46dc: Diviner: Improve documentation for remarkup code blocks

Summary

Improve remarkup reference documentation.

Added a heading for Code Blocks
Added a sentence mentioning the ```lang syntax which was added in T15481: Support language highlighting for GitHub+StackOverflow+GitLab "Flavored Markdown" code blocks

Test Plan

Run bin/diviner generate to regen diviner docs.
Check out the code blocks section of Remarkup Reference

Diff Detail

Repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

20after4 created this revision.Feb 29 2024, 17:33

Owners added a reviewer: O1: Blessed Committers.Feb 29 2024, 17:33

Herald added subscribers: Cigaryno, Matthew, tobiaswiese. · View Herald TranscriptFeb 29 2024, 17:33

20after4 requested review of this revision.Feb 29 2024, 17:33

Harbormaster completed remote builds in B1083: Diff 1729.Feb 29 2024, 17:34

20after4 mentioned this in T15747: Support short language specifier in code blocks: ```php instead of ```lang=php.Feb 29 2024, 17:36

20after4 edited the summary of this revision. (Show Details)Feb 29 2024, 17:39

sgtm

This revision is now accepted and ready to land.Feb 29 2024, 19:40

Closed by commit rP32b5139d46dc: Diviner: Improve documentation for remarkup code blocks. · Explain WhyMar 2 2024, 11:32

This revision was automatically updated to reflect the committed changes.

20after4 added a commit: rP32b5139d46dc: Diviner: Improve documentation for remarkup code blocks.

Revision Contents
Changeset List

Path

Size

Packages

src/

docs/

user/

userguide/

remarkup.diviner

6 lines

O1: Blessed Committers

Diff 1737

src/docs/user/userguide/remarkup.diviner

	Show First 20 Lines • Show All 407 Lines • ▼ Show 20 Lines		if (!empty($monospaced)) {
	// break the CSS. Instead, filter it strictly and then mark it as safe.			// break the CSS. Instead, filter it strictly and then mark it as safe.
	$monospaced = new PhutilSafeHTML(			$monospaced = new PhutilSafeHTML(
	PhabricatorMonospacedFontSetting::filterMonospacedCSSRule(			PhabricatorMonospacedFontSetting::filterMonospacedCSSRule(
	$monospaced));			$monospaced));

	$font_css = hsprintf(			$font_css = hsprintf(
	'<style type="text/css">'.			'<style type="text/css">'.
	'.PhabricatorMonospaced, '.			'.PhabricatorMonospaced, '.
	'.phabricator-remarkup .remarkup-code-block '.			'.phabricator-remarkup .remarkup-code-block .remarkup-code, '.
	'.remarkup-code { font: %s !important; } '.			'.phabricator-remarkup .remarkup-monospaced '.
				'{ font: %s !important; } '.
	'</style>',			'</style>',
	$monospaced);			$monospaced);
	}			}

	return hsprintf(			return hsprintf(
	'%s%s%s%s',			'%s%s%s%s',
	parent::getHead(),			parent::getHead(),
	$font_css,			$font_css,
	▲ Show 20 Lines • Show All 503 Lines • Show Last 20 Lines