Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
2ab7872e
Commit
2ab7872e
authored
Apr 18, 2022
by
Chad Woolley
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix doc wording for GLFM guide
- 'backed' -> 'backend'
parent
5addac5e
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
5 deletions
+5
-5
doc/development/gitlab_flavored_markdown/specification_guide/index.md
...ent/gitlab_flavored_markdown/specification_guide/index.md
+5
-5
No files found.
doc/development/gitlab_flavored_markdown/specification_guide/index.md
View file @
2ab7872e
...
...
@@ -238,7 +238,7 @@ by a [canonicalization](#canonicalization-of-html) process.
#### Canonicalization of HTML
Neither the backed (Ruby) nor the frontend (JavaScript) rendered can directly render canonical HTML.
Neither the backe
n
d (Ruby) nor the frontend (JavaScript) rendered can directly render canonical HTML.
Nor should they be able to, because:
-
It's not a direct requirement to support any GitLab application feature.
...
...
@@ -282,7 +282,7 @@ specification and testing infrastructure:
which is a
[
script used to run the Markdown conformance tests
](
https://github.github.com/gfm/#about-this-document
)
against all examples contained in a
`spec.txt`
.
1.
The GLFM parsers and HTML renderers for
both the static backed (Ruby) and WYSIWYG frontend (JavaScript) implementations
both the static backe
n
d (Ruby) and WYSIWYG frontend (JavaScript) implementations
support _consistent_ rendering of all canonical Markdown + HTML examples in the
GLFM
`spec.txt`
specification, as verified by
`spec_tests.py`
.
...
...
@@ -292,7 +292,7 @@ specification and testing infrastructure:
to the HTML they render, so therefore their rendered HTML is
[
"canonicalized"
](
#canonicalization-of-html
)
to canonical HTML prior running
the Markdown conformance tests.
1.
For _both_ the static backed (Ruby) and WYSIWYG frontend (JavaScript) implementations,
1.
For _both_ the static backe
n
d (Ruby) and WYSIWYG frontend (JavaScript) implementations,
a set of example snapshots exists in the form of YAML files, which
correspond to every Markdown example in the GLFM
`spec.txt`
. These example snapshots
support the following usages for every GLFM Markdown example:
...
...
@@ -570,7 +570,7 @@ The `example_snapshots` directory contains files which are generated by the
`glfm_specification/input`
directory. They are used as fixtures to drive the
various Markdown snapshot tests.
After the entire GLFM implementation is complete for both backed (Ruby) and
After the entire GLFM implementation is complete for both backe
n
d (Ruby) and
frontend (JavaScript), all of these YAML files can be automatically generated.
However, while the implementations are still in progress, the
`skip_update_example_snapshots`
key in
`glfm_specification/input/gitlab_flavored_markdown/glfm_example_status.yml`
...
...
@@ -651,7 +651,7 @@ Three types of entries exist, with different HTML for each:
-
For GLFM examples, it is generated/updated from
`glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt`
.
-
**Static**
-
This is the static (backed (Ruby)-generated) HTML for each entry in
-
This is the static (backe
n
d (Ruby)-generated) HTML for each entry in
`spec/fixtures/glfm/example_snapshots/examples_index.yml`
.
-
It is generated/updated from backend
[
Markdown API
](
../../../api/markdown.md
)
(or the underlying internal classes) via the
`update-example-snapshots.rb`
script,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment