Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-11-03 12:10:37 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2022-11-03 12:10:37 +0300
commit058bd6be52a5e68ea81f9026201b1136610336b1 (patch)
tree82681bd6b793ca4d7208fc4fb4f49c47d77dd1f3 /doc/development/gitlab_flavored_markdown
parentbbc0882f5730aff94a0739a481b42143708949c2 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/gitlab_flavored_markdown')
-rw-r--r--doc/development/gitlab_flavored_markdown/specification_guide/index.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/development/gitlab_flavored_markdown/specification_guide/index.md b/doc/development/gitlab_flavored_markdown/specification_guide/index.md
index e64c145b3a3..17afebcf6ee 100644
--- a/doc/development/gitlab_flavored_markdown/specification_guide/index.md
+++ b/doc/development/gitlab_flavored_markdown/specification_guide/index.md
@@ -1144,7 +1144,7 @@ The `output_example_snapshots` directory contains files which are generated by t
`glfm_specification/input` directory.
The `output-specification.rb` script generates
-`output_snapshot_examples/glfm_snapshot_spec.md` and `output_snapshot_examples/glfm_snapshot_spec.html`.
+`output_snapshot_examples/snapshot_spec.md` and `output_snapshot_examples/snapshot_spec.html`.
These files are Markdown specification files containing examples generated based on input files,
similar to the `output_spec/spec.txt` and `output_spec/spec.html`, with the following differences:
@@ -1166,9 +1166,9 @@ key in `glfm_specification/input/gitlab_flavored_markdown/glfm_example_status.ym
can be used to disable automatic generation of some examples. They can instead
be manually edited as necessary to help drive the implementations.
-##### `glfm_snapshot_spec.md`
+##### `snapshot_spec.md`
-[`glfm_specification/output_example_snapshots/glfm_snapshot_spec.md`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/glfm_specification/output_example_snapshots/glfm_snapshot_spec.md)
+[`glfm_specification/output_example_snapshots/snapshot_spec.md`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/glfm_specification/output_example_snapshots/snapshot_spec.md)
is a Markdown file, containing standard Markdown + canonical HTML examples like [`spec.txt`](#spectxt).
It is generated or updated by the `update-specification.rb` script, using the
@@ -1180,26 +1180,26 @@ scripts such as `update-example-snapshots.rb`.
It is similar to [`spec.txt`](#spectxt), with the following differences:
1. [`spec.txt`](#spectxt) contains only examples for GitLab Flavored Markdown, but
- `glfm_snapshot_spec.md` also contains the full superset of examples from the
+ `snapshot_spec.md` also contains the full superset of examples from the
"GitHub Flavored Markdown" (<abbr title="GitHub Flavored Markdown">GFM</abbr>)[specification](https://github.github.com/gfm/)
and the [CommonMark specification](https://spec.commonmark.org/0.30/) specifications.
1. [`spec.txt`](#spectxt) represents the full GLFM specification, including additional header sections
- containing only explanatory prose and no examples, but `glfm_snapshot_spec.md` consists of only
+ containing only explanatory prose and no examples, but `snapshot_spec.md` consists of only
header sections which contain examples. This is because its purpose is to serve as input for
the other [`output example snapshot files`](#output-example-snapshot-files) - it is not intended
to serve as an actual [specification file](#output-specification-files)
like [`spec.txt`](#spectxt) or [`spec.html`](#spechtml).
-##### `glfm_snapshot_spec.html`
+##### `snapshot_spec.html`
-[`glfm_specification/output_snapshot_examples/glfm_snapshot_spec.html`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/glfm_specification/output_snapshot_examples/glfm_snapshot_spec.html)
-is an HTML file, rendered based on `glfm_snapshot_spec.md`. It is
+[`glfm_specification/output_snapshot_examples/snapshot_spec.html`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/glfm_specification/output_snapshot_examples/snapshot_spec.html)
+is an HTML file, rendered based on `snapshot_spec.md`. It is
generated (or updated) by the `update-specification.rb` script at the same time as
-`glfm_snapshot_spec.md`.
+`snapshot_spec.md`.
NOTE:
The formatting of this HTML is currently not identical to the GFM and CommonMark
-HTML-rendered specification. It is only the raw output of running `glfm_snapshot_spec.md` through
+HTML-rendered specification. It is only the raw output of running `snapshot_spec.md` through
the GitLab Markdown renderer. Properly formatting the HTML will require
duplicating or reusing the Lua script and template from the CommonMark project:
[CommonMark Makefile](https://github.com/commonmark/commonmark-spec/blob/master/Makefile#L11)