From b556d0fab74a7ef460d868e508ea5ca72d0e5eed Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Tue, 18 Oct 2022 15:10:37 +0000 Subject: [PATCH] Add latest changes from gitlab-org/gitlab@master --- .../rails/active_record_callbacks_order.yml | 5 +- .rubocop_todo/rails/inverse_of.yml | 17 +- .../style/keyword_parameters_order.yml | 15 +- Gemfile | 3 +- Gemfile.checksum | 10 +- Gemfile.lock | 16 +- .../stylesheets/lazy_bundles/gridstack.scss | 1 + app/models/concerns/boards/listable.rb | 2 +- app/services/boards/lists/list_service.rb | 20 +- ..._factor_otp_attempt_failed_email.html.haml | 2 +- ..._factor_otp_attempt_failed_email.text.haml | 2 +- .../notify/unknown_sign_in_email.html.haml | 2 +- .../notify/unknown_sign_in_email.text.haml | 2 +- config/application.rb | 1 + .../geo/replication/datatypes.md | 5 +- .../reference_architectures/10k_users.md | 51 +- .../reference_architectures/25k_users.md | 50 +- .../reference_architectures/2k_users.md | 28 +- .../reference_architectures/3k_users.md | 35 +- .../reference_architectures/50k_users.md | 50 +- .../reference_architectures/5k_users.md | 36 +- .../gitlab_rails_cheat_sheet.md | 21 + doc/api/users.md | 33 +- .../ci_data_decay/pipeline_partitioning.md | 16 +- .../blueprints/runner_scaling/index.md | 108 +- doc/ci/git_submodules.md | 8 + doc/ci/runners/configure_runners.md | 27 + doc/development/database/foreign_keys.md | 98 +- .../fe_guide/customizable_dashboards.md | 99 + doc/development/feature_development.md | 1 + doc/development/json.md | 46 + doc/subscriptions/index.md | 5 +- glfm_specification/output/spec.html | 9220 ++++++++++++++++- lib/api/entities/user_with_admin.rb | 1 + lib/api/helpers/projects_helpers.rb | 4 +- lib/api/project_export.rb | 3 +- lib/api/project_import.rb | 2 +- lib/gitlab/gon_helper.rb | 1 + lib/tasks/gitlab/tw/codeowners.rake | 12 +- locale/gitlab.pot | 6 + package.json | 1 + scripts/lib/glfm/constants.rb | 1 + scripts/lib/glfm/render_static_html.rb | 9 +- scripts/lib/glfm/update_example_snapshots.rb | 6 +- scripts/lib/glfm/update_specification.rb | 71 +- spec/mailers/emails/profile_spec.rb | 4 +- spec/requests/api/users_spec.rb | 22 + .../lib/glfm/update_example_snapshots_spec.rb | 10 +- .../lib/glfm/update_specification_spec.rb | 106 +- .../boards/lists/list_service_spec.rb | 34 +- .../models/boards/listable_shared_examples.rb | 8 - yarn.lock | 5 + 52 files changed, 9953 insertions(+), 388 deletions(-) create mode 100644 app/assets/stylesheets/lazy_bundles/gridstack.scss create mode 100644 doc/development/fe_guide/customizable_dashboards.md create mode 100644 doc/development/json.md diff --git a/.rubocop_todo/rails/active_record_callbacks_order.yml b/.rubocop_todo/rails/active_record_callbacks_order.yml index 9585a720c6a..11ffff36e8d 100644 --- a/.rubocop_todo/rails/active_record_callbacks_order.yml +++ b/.rubocop_todo/rails/active_record_callbacks_order.yml @@ -1,12 +1,9 @@ --- # Cop supports --auto-correct. Rails/ActiveRecordCallbacksOrder: - # Offense count: 30 - # Temporarily disabled due to too many offenses - Enabled: false + Details: grace period Exclude: - 'app/models/award_emoji.rb' - - 'app/models/ci/job_artifact.rb' - 'app/models/gpg_key.rb' - 'app/models/group.rb' - 'app/models/issue.rb' diff --git a/.rubocop_todo/rails/inverse_of.yml b/.rubocop_todo/rails/inverse_of.yml index 98d116c3319..262804739bd 100644 --- a/.rubocop_todo/rails/inverse_of.yml +++ b/.rubocop_todo/rails/inverse_of.yml @@ -1,8 +1,6 @@ --- Rails/InverseOf: - # Offense count: 210 - # Temporarily disabled due to too many offenses - Enabled: false + Details: grace period Exclude: - 'app/models/alert_management/alert.rb' - 'app/models/alert_management/alert_assignee.rb' @@ -12,7 +10,6 @@ Rails/InverseOf: - 'app/models/board.rb' - 'app/models/bulk_imports/entity.rb' - 'app/models/bulk_imports/tracker.rb' - - 'app/models/chat_name.rb' - 'app/models/ci/bridge.rb' - 'app/models/ci/build.rb' - 'app/models/ci/build_pending_state.rb' @@ -25,7 +22,6 @@ Rails/InverseOf: - 'app/models/ci/runner.rb' - 'app/models/ci/runner_namespace.rb' - 'app/models/ci/sources/pipeline.rb' - - 'app/models/ci/stage.rb' - 'app/models/ci/trigger_request.rb' - 'app/models/ci/unit_test_failure.rb' - 'app/models/clusters/applications/runner.rb' @@ -38,7 +34,6 @@ Rails/InverseOf: - 'app/models/concerns/analytics/cycle_analytics/stage.rb' - 'app/models/concerns/awardable.rb' - 'app/models/concerns/commit_signature.rb' - - 'app/models/concerns/merge_request_reviewer_state.rb' - 'app/models/concerns/with_uploads.rb' - 'app/models/custom_emoji.rb' - 'app/models/customer_relations/contact.rb' @@ -51,7 +46,7 @@ Rails/InverseOf: - 'app/models/group.rb' - 'app/models/group/crm_settings.rb' - 'app/models/group_group_link.rb' - - 'app/models/hooks/service_hook.rb' + - 'app/models/group_label.rb' - 'app/models/incident_management/timeline_event.rb' - 'app/models/integrations/base_slash_commands.rb' - 'app/models/issue.rb' @@ -66,11 +61,15 @@ Rails/InverseOf: - 'app/models/packages/composer/cache_file.rb' - 'app/models/packages/maven/metadatum.rb' - 'app/models/project.rb' + - 'app/models/project_label.rb' - 'app/models/resource_state_event.rb' - 'app/models/serverless/domain_cluster.rb' - 'app/models/terraform/state_version.rb' + - 'app/models/time_tracking/timelog_category.rb' - 'app/models/todo.rb' - 'app/models/user.rb' + - 'app/models/users/phone_number_validation.rb' + - 'app/models/work_item.rb' - 'app/models/x509_certificate.rb' - 'ee/app/models/allowed_email_domain.rb' - 'ee/app/models/analytics/cycle_analytics/group_stage.rb' @@ -78,12 +77,14 @@ Rails/InverseOf: - 'ee/app/models/analytics/devops_adoption/enabled_namespace.rb' - 'ee/app/models/analytics/devops_adoption/snapshot.rb' - 'ee/app/models/audit_events/external_audit_event_destination.rb' + - 'ee/app/models/audit_events/streaming/header.rb' - 'ee/app/models/ci/sources/project.rb' - 'ee/app/models/compliance_management/compliance_framework/project_settings.rb' - 'ee/app/models/concerns/incident_management/base_pending_escalation.rb' - 'ee/app/models/dast/profile_schedule.rb' - 'ee/app/models/ee/ci/build.rb' - 'ee/app/models/ee/ci/pipeline.rb' + - 'ee/app/models/ee/clusters/agent.rb' - 'ee/app/models/ee/epic.rb' - 'ee/app/models/ee/group.rb' - 'ee/app/models/ee/iteration.rb' @@ -105,9 +106,9 @@ Rails/InverseOf: - 'ee/app/models/integrations/gitlab_slack_application.rb' - 'ee/app/models/requirements_management/requirement.rb' - 'ee/app/models/requirements_management/test_report.rb' + - 'ee/app/models/sbom/vulnerable_component_version.rb' - 'ee/app/models/security/orchestration_policy_configuration.rb' - 'ee/app/models/security/orchestration_policy_rule_schedule.rb' - - 'ee/app/models/slack_integration.rb' - 'ee/app/models/software_license_policy.rb' - 'ee/app/models/user_permission_export_upload.rb' - 'ee/app/models/vulnerabilities/feedback.rb' diff --git a/.rubocop_todo/style/keyword_parameters_order.yml b/.rubocop_todo/style/keyword_parameters_order.yml index 0bb499cebb0..3521f295cc1 100644 --- a/.rubocop_todo/style/keyword_parameters_order.yml +++ b/.rubocop_todo/style/keyword_parameters_order.yml @@ -1,10 +1,9 @@ --- # Cop supports --auto-correct. Style/KeywordParametersOrder: - # Offense count: 110 - # Temporarily disabled due to too many offenses - Enabled: false + Details: grace period Exclude: + - 'app/controllers/concerns/product_analytics_tracking.rb' - 'app/finders/group_descendants_finder.rb' - 'app/finders/merge_request_target_project_finder.rb' - 'app/graphql/resolvers/package_pipelines_resolver.rb' @@ -30,20 +29,23 @@ Style/KeywordParametersOrder: - 'ee/app/services/analytics/devops_adoption/enabled_namespaces/create_service.rb' - 'ee/app/services/analytics/devops_adoption/enabled_namespaces/find_or_create_service.rb' - 'ee/app/services/audit_events/user_impersonation_group_audit_event_service.rb' - - 'ee/app/services/members/activate_service.rb' - 'ee/lib/gitlab/elastic/helper.rb' + - 'ee/lib/gitlab/insights/executors/dora_executor.rb' + - 'ee/lib/gitlab/insights/executors/issuable_executor.rb' - 'ee/spec/lib/ee/gitlab/background_migration/drop_invalid_remediations_spec.rb' - 'ee/spec/requests/api/deployments_spec.rb' + - 'lib/gitlab/background_migration/batched_migration_job.rb' - 'lib/gitlab/checks/timed_logger.rb' - 'lib/gitlab/ci/reports/security/finding.rb' + - 'lib/gitlab/cleanup/personal_access_tokens.rb' - 'lib/gitlab/database/partitioning/monthly_strategy.rb' - 'lib/gitlab/database/with_lock_retries.rb' - 'lib/gitlab/diff/diff_refs.rb' - 'lib/gitlab/email/smime/signer.rb' - - 'lib/gitlab/error_tracking.rb' - 'lib/gitlab/exclusive_lease.rb' - 'lib/gitlab/import_export/import_failure_service.rb' - 'lib/gitlab/merge_requests/mergeability/results_store.rb' + - 'lib/gitlab/usage_data_counters/editor_unique_counter.rb' - 'lib/microsoft_teams/notifier.rb' - 'qa/qa/specs/features/ee/browser_ui/3_create/repository/file_locking_spec.rb' - 'qa/qa/specs/features/ee/browser_ui/3_create/repository/push_rules_spec.rb' @@ -64,9 +66,12 @@ Style/KeywordParametersOrder: - 'spec/migrations/20220107064845_populate_vulnerability_reads_spec.rb' - 'spec/migrations/confirm_support_bot_user_spec.rb' - 'spec/services/service_ping/submit_service_ping_service_spec.rb' + - 'spec/support/helpers/doc_url_helper.rb' - 'spec/support/helpers/smime_helper.rb' - 'spec/support/helpers/workhorse_helpers.rb' + - 'spec/support/shared_examples/projects/container_repository/cleanup_tags_service_shared_examples.rb' - 'spec/support/shared_examples/services/container_expiration_policy_shared_examples.rb' - 'spec/support/shared_examples/services/dependency_proxy_ttl_policies_shared_examples.rb' - 'spec/support/shared_examples/services/namespace_package_settings_shared_examples.rb' + - 'spec/tasks/gitlab/usage_data_rake_spec.rb' - 'spec/workers/container_expiration_policies/cleanup_container_repository_worker_spec.rb' diff --git a/Gemfile b/Gemfile index 65ed6078dc5..1e821fdce6c 100644 --- a/Gemfile +++ b/Gemfile @@ -43,7 +43,7 @@ gem 'rugged', '~> 1.2' gem 'grape-path-helpers', '~> 1.7.1' gem 'faraday', '~> 1.0' -gem 'marginalia', '~> 1.10.0' +gem 'marginalia', '~> 1.11.1' # Authorization gem 'declarative_policy', '~> 1.1.0' @@ -478,7 +478,6 @@ gem 'gitlab-mail_room', '~> 0.0.9', require: 'mail_room' gem 'email_reply_trimmer', '~> 0.1' gem 'html2text' -gem 'ruby-prof', '~> 1.3.0' gem 'stackprof', '~> 0.2.21', require: false gem 'rbtrace', '~> 0.4', require: false gem 'memory_profiler', '~> 0.9', require: false diff --git a/Gemfile.checksum b/Gemfile.checksum index 509fb46286c..32e51d14d92 100644 --- a/Gemfile.checksum +++ b/Gemfile.checksum @@ -319,7 +319,7 @@ {"name":"lumberjack","version":"1.2.7","platform":"ruby","checksum":"a5c6aae6b4234f1420dbcd80b23e3bca0817bd239440dde097ebe3fa63c63b1f"}, {"name":"mail","version":"2.7.1","platform":"ruby","checksum":"ec2a3d489f7510b90d8eaa3f6abaad7038cf1d663cdf8ee66d0214a0bdf99c03"}, {"name":"marcel","version":"1.0.2","platform":"ruby","checksum":"a013b677ef46cbcb49fd5c59b3d35803d2ee04dd75d8bfdc43533fc5a31f7e4e"}, -{"name":"marginalia","version":"1.10.0","platform":"ruby","checksum":"68289091ee493e1a8f22369c245f250652a6538e497fdeef68cb2a2490830380"}, +{"name":"marginalia","version":"1.11.1","platform":"ruby","checksum":"cb63212ab63e42746e27595e912cb20408a1a28bcd0edde55d15b7c45fa289cf"}, {"name":"memoist","version":"0.16.2","platform":"ruby","checksum":"a52c53a3f25b5875151670b2f3fd44388633486dc0f09f9a7150ead1e3bf3c45"}, {"name":"memory_profiler","version":"0.9.14","platform":"ruby","checksum":"de558cf6525d8d56d2c0ea465b1664517fbe45560f892dc7a898d3b8c2863b12"}, {"name":"method_source","version":"1.0.0","platform":"ruby","checksum":"d779455a2b5666a079ce58577bfad8534f571af7cec8107f4dce328f0981dede"}, @@ -484,14 +484,14 @@ {"name":"rqrcode-rails3","version":"0.1.7","platform":"ruby","checksum":"6f0582f26485123e5ed6f2a8a2871f00d86d353e0f58c8429a5a13212bcf48c4"}, {"name":"rspec","version":"3.10.0","platform":"ruby","checksum":"b870b43d49ae4a4e063b94976d2742b0854ec10458c425d569b5556ee5898ab7"}, {"name":"rspec-benchmark","version":"0.6.0","platform":"ruby","checksum":"1014adb57ec2599a2455c63884229f367a2fff6a63a77fd68ce5d804c83dd6cf"}, -{"name":"rspec-core","version":"3.10.1","platform":"ruby","checksum":"ac9abdc9577a3a34e9e92815603da8343931055ab4fba1c2a49de6dd3b749673"}, +{"name":"rspec-core","version":"3.10.2","platform":"ruby","checksum":"005659ce9dd356dd5d2acb4bcdcc5915291f4a312447b500af3b75aab564951b"}, {"name":"rspec-expectations","version":"3.10.1","platform":"ruby","checksum":"27acf5d5df13f8cc8f7158001ebf572513bcec3d45404ba76e0a8998895ce9eb"}, {"name":"rspec-mocks","version":"3.10.3","platform":"ruby","checksum":"d2f6f3d8b7569b1e846703d164cb23e24c7f530d38217fc06da2beaf6024260a"}, {"name":"rspec-parameterized","version":"0.5.0","platform":"ruby","checksum":"f163ac07b5edd1eeb13136480623db7020852c70cf0ad2fa98e31384ae162454"}, {"name":"rspec-rails","version":"5.0.1","platform":"ruby","checksum":"c61e7f35db2266f83b3cc58a340fc3ec0bd6344818040430fd5ddc99775242de"}, {"name":"rspec-retry","version":"0.6.1","platform":"ruby","checksum":"86b7e8513c5b0c713c2e28854f4d996deb8efa6304eef50f0ad68ee6c563d8da"}, -{"name":"rspec-support","version":"3.10.2","platform":"ruby","checksum":"74315f89069fbaf2a710e2117340373b77ee45eceb026de87e0cad9dd5154596"}, -{"name":"rspec_junit_formatter","version":"0.4.1","platform":"ruby","checksum":"3788f9b3fabc6284b93493cf4b3a80cba2b59b3a774b95f39dd7886d5faed6ab"}, +{"name":"rspec-support","version":"3.10.3","platform":"ruby","checksum":"65c88f8cbe579461f411097682e6402960eae327eef08e86ef581b8c609e4c5e"}, +{"name":"rspec_junit_formatter","version":"0.6.0","platform":"ruby","checksum":"40dde674e6ae4e6cc0ff560da25497677e34fefd2338cc467a8972f602b62b15"}, {"name":"rspec_profiling","version":"0.0.6","platform":"ruby","checksum":"7a45697f79dcec9a174a0e26703465f6bd52ee78e8d798741240bfcef38f6e6e"}, {"name":"rubocop","version":"1.36.0","platform":"ruby","checksum":"368e47dcab8417419949bbadb11ec41fd94e6b785f8bff4f9cc56a1ddf60ffac"}, {"name":"rubocop-ast","version":"1.21.0","platform":"ruby","checksum":"8f5d98611343498602de2d41bc583aca71599daad16daeadaeeee60f134c9568"}, @@ -502,8 +502,6 @@ {"name":"rubocop-rspec","version":"2.12.1","platform":"ruby","checksum":"9278d22d4525261caf30d591eef3d47910a125e74f75f41ffa470acd208423f9"}, {"name":"ruby-fogbugz","version":"0.2.1","platform":"ruby","checksum":"15b2e7fe7e95b021a94ee6e9d8bb32fdad6ae44e820c2ce0dc312fe6e77d40ca"}, {"name":"ruby-magic","version":"0.5.4","platform":"ruby","checksum":"2c17b185130d10a83791f63a40baa358c4b138af37da3f4dab53690121c421d5"}, -{"name":"ruby-prof","version":"1.3.1","platform":"ruby","checksum":"e735d20c92954e1fa2a4475539c99dfc8d0166b4cc6915ca309e8ee2dd19323c"}, -{"name":"ruby-prof","version":"1.3.1","platform":"x64-mingw32","checksum":"a97bb6ff0abb01131ecba88799222d492d9124e057535db8e5bd47119f2a58ba"}, {"name":"ruby-progressbar","version":"1.11.0","platform":"ruby","checksum":"cc127db3866dc414ffccbf92928a241e585b3aa2b758a5563e74a6ee0f57d50a"}, {"name":"ruby-saml","version":"1.13.0","platform":"ruby","checksum":"d31cbdf5fb8fdd6aa3187e48dba3085cfeb751af30276a5739aa3659a66f069c"}, {"name":"ruby-statistics","version":"3.0.0","platform":"ruby","checksum":"610301370346931cb701e3a8d3d3e28eb65681162cae6066c0c11abf20efdc81"}, diff --git a/Gemfile.lock b/Gemfile.lock index 24e4c532f08..7913193127f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -854,9 +854,9 @@ GEM mail (2.7.1) mini_mime (>= 0.1.1) marcel (1.0.2) - marginalia (1.10.0) - actionpack (>= 2.3) - activerecord (>= 2.3) + marginalia (1.11.1) + actionpack (>= 5.2) + activerecord (>= 5.2) memoist (0.16.2) memory_profiler (0.9.14) method_source (1.0.0) @@ -1190,7 +1190,7 @@ GEM benchmark-perf (~> 0.6) benchmark-trend (~> 0.4) rspec (>= 3.0) - rspec-core (3.10.1) + rspec-core (3.10.2) rspec-support (~> 3.10.0) rspec-expectations (3.10.1) diff-lcs (>= 1.2.0, < 2.0) @@ -1214,8 +1214,8 @@ GEM rspec-support (~> 3.10) rspec-retry (0.6.1) rspec-core (> 3.3) - rspec-support (3.10.2) - rspec_junit_formatter (0.4.1) + rspec-support (3.10.3) + rspec_junit_formatter (0.6.0) rspec-core (>= 2, < 4, != 2.12.0) rspec_profiling (0.0.6) activerecord @@ -1251,7 +1251,6 @@ GEM crack (~> 0.4) ruby-magic (0.5.4) mini_portile2 (~> 2.6) - ruby-prof (1.3.1) ruby-progressbar (1.11.0) ruby-saml (1.13.0) nokogiri (>= 1.10.5) @@ -1692,7 +1691,7 @@ DEPENDENCIES lru_redux mail (= 2.7.1) mail-smtp_pool (~> 0.1.0)! - marginalia (~> 1.10.0) + marginalia (~> 1.11.1) memory_profiler (~> 0.9) microsoft_graph_mailer (~> 0.1.0)! mini_magick (~> 4.10.1) @@ -1772,7 +1771,6 @@ DEPENDENCIES rubocop ruby-fogbugz (~> 0.2.1) ruby-magic (~> 0.5) - ruby-prof (~> 1.3.0) ruby-progressbar (~> 1.10) ruby-saml (~> 1.13.0) ruby_parser (~> 3.15) diff --git a/app/assets/stylesheets/lazy_bundles/gridstack.scss b/app/assets/stylesheets/lazy_bundles/gridstack.scss new file mode 100644 index 00000000000..235b225d747 --- /dev/null +++ b/app/assets/stylesheets/lazy_bundles/gridstack.scss @@ -0,0 +1 @@ +@import 'gridstack/dist/gridstack'; diff --git a/app/models/concerns/boards/listable.rb b/app/models/concerns/boards/listable.rb index b9827a79422..b09ef7e612d 100644 --- a/app/models/concerns/boards/listable.rb +++ b/app/models/concerns/boards/listable.rb @@ -13,7 +13,7 @@ module Boards scope :ordered, -> { order(:list_type, :position) } scope :destroyable, -> { where(list_type: list_types.slice(*destroyable_types).values) } scope :movable, -> { where(list_type: list_types.slice(*movable_types).values) } - scope :without_types, ->(list_types) { where.not(list_type: list_types) } + scope :with_types, ->(list_types) { where(list_type: list_types) } class << self def preload_preferences_for_user(lists, user) diff --git a/app/services/boards/lists/list_service.rb b/app/services/boards/lists/list_service.rb index e81ef467a4e..cf15db4314c 100644 --- a/app/services/boards/lists/list_service.rb +++ b/app/services/boards/lists/list_service.rb @@ -9,23 +9,27 @@ module Boards end lists = board.lists.preload_associated_models + lists = lists.with_types(available_list_types_for(board)) return lists.id_in(params[:list_id]) if params[:list_id].present? - list_types = unavailable_list_types_for(board) - lists.without_types(list_types) + lists end private - def unavailable_list_types_for(board) - hidden_lists_for(board) + def available_list_types_for(board) + licensed_list_types(board) + visible_lists(board) end - def hidden_lists_for(board) - [].tap do |hidden| - hidden << ::List.list_types[:backlog] if board.hide_backlog_list? - hidden << ::List.list_types[:closed] if board.hide_closed_list? + def licensed_list_types(board) + [List.list_types[:label]] + end + + def visible_lists(board) + [].tap do |visible| + visible << ::List.list_types[:backlog] unless board.hide_backlog_list? + visible << ::List.list_types[:closed] unless board.hide_closed_list? end end end diff --git a/app/views/notify/two_factor_otp_attempt_failed_email.html.haml b/app/views/notify/two_factor_otp_attempt_failed_email.html.haml index aea5a626636..fec7083e524 100644 --- a/app/views/notify/two_factor_otp_attempt_failed_email.html.haml +++ b/app/views/notify/two_factor_otp_attempt_failed_email.html.haml @@ -42,7 +42,7 @@ %tbody %tr{ style: 'width:100%;' } %td{ style: "#{default_style}text-align:center;" } - - password_link_start = ''.html_safe % { url: 'https://docs.gitlab.com/ee/user/profile/#changing-your-password' } + - password_link_start = ''.html_safe % { url: 'https://docs.gitlab.com/ee/user/profile/user_passwords.html#change-your-password' } = _('If you recently tried to sign in, but mistakenly entered a wrong two-factor authentication code, you may ignore this email.') - if password_authentication_enabled_for_web? diff --git a/app/views/notify/two_factor_otp_attempt_failed_email.text.haml b/app/views/notify/two_factor_otp_attempt_failed_email.text.haml index 0a5784ab835..8f839cd83ee 100644 --- a/app/views/notify/two_factor_otp_attempt_failed_email.text.haml +++ b/app/views/notify/two_factor_otp_attempt_failed_email.text.haml @@ -3,5 +3,5 @@ = _('We detected an attempt to sign in to your %{host} account using a wrong two-factor authentication code, from the following IP address: %{ip}, at %{time}') % { host: Gitlab.config.gitlab.host, ip: @ip, time: @time } = _('If you recently tried to sign in, but mistakenly entered a wrong two-factor authentication code, you may ignore this email.') -= _('If you did not recently try to sign in, you should immediately change your password: %{password_link}.') % { password_link: 'https://docs.gitlab.com/ee/user/profile/#changing-your-password' } += _('If you did not recently try to sign in, you should immediately change your password: %{password_link}.') % { password_link: 'https://docs.gitlab.com/ee/user/profile/user_passwords.html#change-your-password' } = _('Make sure you choose a strong, unique password.') diff --git a/app/views/notify/unknown_sign_in_email.html.haml b/app/views/notify/unknown_sign_in_email.html.haml index 47c5656db27..b1c79274e26 100644 --- a/app/views/notify/unknown_sign_in_email.html.haml +++ b/app/views/notify/unknown_sign_in_email.html.haml @@ -42,7 +42,7 @@ %tbody %tr{ style: 'width:100%;' } %td{ style: "#{default_style}text-align:center;" } - - password_link_start = ''.html_safe % { url: 'https://docs.gitlab.com/ee/user/profile/#changing-your-password' } + - password_link_start = ''.html_safe % { url: 'https://docs.gitlab.com/ee/user/profile/user_passwords.html#change-your-password' } = _('If you recently signed in and recognize the IP address, you may disregard this email.') - if password_authentication_enabled_for_web? diff --git a/app/views/notify/unknown_sign_in_email.text.haml b/app/views/notify/unknown_sign_in_email.text.haml index f3efc4c4fcd..54c7a245ab9 100644 --- a/app/views/notify/unknown_sign_in_email.text.haml +++ b/app/views/notify/unknown_sign_in_email.text.haml @@ -3,7 +3,7 @@ = _('A sign-in to your account has been made from the following IP address: %{ip}') % { ip: @ip } = _('If you recently signed in and recognize the IP address, you may disregard this email.') -= _('If you did not recently sign in, you should immediately change your password: %{password_link}.') % { password_link: 'https://docs.gitlab.com/ee/user/profile/#changing-your-password' } += _('If you did not recently sign in, you should immediately change your password: %{password_link}.') % { password_link: 'https://docs.gitlab.com/ee/user/profile/user_passwords.html#change-your-password' } = _('Passwords should be unique and not used for any other sites or services.') - unless @user.two_factor_enabled? diff --git a/config/application.rb b/config/application.rb index d45e0bab54d..368036ce064 100644 --- a/config/application.rb +++ b/config/application.rb @@ -324,6 +324,7 @@ module Gitlab config.assets.precompile << "page_bundles/xterm.css" config.assets.precompile << "lazy_bundles/cropper.css" config.assets.precompile << "lazy_bundles/select2.css" + config.assets.precompile << "lazy_bundles/gridstack.css" config.assets.precompile << "performance_bar.css" config.assets.precompile << "disable_animations.css" config.assets.precompile << "test_environment.css" diff --git a/doc/administration/geo/replication/datatypes.md b/doc/administration/geo/replication/datatypes.md index d77ffb97293..69883b159c3 100644 --- a/doc/administration/geo/replication/datatypes.md +++ b/doc/administration/geo/replication/datatypes.md @@ -199,7 +199,8 @@ successfully, you must replicate their data using some other means. |[CI job artifacts](../../../ci/pipelines/job_artifacts.md) | **Yes** (10.4) | **Yes** (14.10) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [No](object_storage.md#verification-of-files-in-object-storage) | Verification is behind the feature flag `geo_job_artifact_replication`, enabled by default in 14.10. | |[CI Pipeline Artifacts](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/models/ci/pipeline_artifact.rb) | [**Yes** (13.11)](https://gitlab.com/gitlab-org/gitlab/-/issues/238464) | [**Yes** (13.11)](https://gitlab.com/gitlab-org/gitlab/-/issues/238464) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [No](object_storage.md#verification-of-files-in-object-storage) | Persists additional artifacts after a pipeline completes. | |[CI Secure Files](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/models/ci/secure_file.rb) | [**Yes** (15.3)](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91430) | [**Yes** (15.3)](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91430) | [**Yes** (15.3)](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/91430) | [No](object_storage.md#verification-of-files-in-object-storage) | Verification is behind the feature flag `geo_ci_secure_file_replication`, enabled by default in 15.3. | -|[Container Registry](../../packages/container_registry.md) | **Yes** (12.3) | No | No | No | Disabled by default. See [instructions](container_registry.md) to enable. | +|[Container Registry](../../packages/container_registry.md) | **Yes** (12.3)* | No | No | No | Replication is behind feature flag `geo_container_repository_replication`, enabled by default. +Requires additional configuration. See [instructions](container_registry.md) to set up the Container Registry replication. | |[Infrastructure Registry](../../../user/packages/infrastructure_registry/index.md) | **Yes** (14.0) | **Yes** (14.0) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [No](object_storage.md#verification-of-files-in-object-storage) | Behind feature flag `geo_package_file_replication`, enabled by default. | |[Project designs repository](../../../user/project/issues/design_management.md) | **Yes** (12.7) | [No](https://gitlab.com/gitlab-org/gitlab/-/issues/32467) | N/A | N/A | Designs also require replication of LFS objects and Uploads. | |[Package Registry](../../../user/packages/package_registry/index.md) | **Yes** (13.2) | **Yes** (13.10) | [**Yes** (15.1)](https://gitlab.com/groups/gitlab-org/-/epics/5551) | [No](object_storage.md#verification-of-files-in-object-storage) | Behind feature flag `geo_package_file_replication`, enabled by default. | @@ -214,3 +215,5 @@ successfully, you must replicate their data using some other means. |[Elasticsearch integration](../../../integration/advanced_search/elasticsearch.md) | [Not planned](https://gitlab.com/gitlab-org/gitlab/-/issues/1186) | No | No | No | Not planned because further product discovery is required and Elasticsearch (ES) clusters can be rebuilt. Secondaries use the same ES cluster as the primary. | |[Dependency proxy images](../../../user/packages/dependency_proxy/index.md) | [Planned](https://gitlab.com/groups/gitlab-org/-/epics/8833) | No | No | No | Blocked by [Geo: Secondary Mimicry](https://gitlab.com/groups/gitlab-org/-/epics/1528). Replication of this cache is not needed for disaster recovery purposes because it can be recreated from external sources. | |[Vulnerability Export](../../../user/application_security/vulnerability_report/index.md#export-vulnerability-details) | [Not planned](https://gitlab.com/groups/gitlab-org/-/epics/3111) | No | No | No | Not planned because they are ephemeral and sensitive information. They can be regenerated on demand. | + +\* Migrated to [self-service framework](../../../development/geo/framework.md) in 15.5. See GitLab issue [#337436](https://gitlab.com/gitlab-org/gitlab/-/issues/337436) for more details. diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index 46f1b194a04..45939b48f78 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -1696,7 +1696,9 @@ To configure Praefect with TLS: Sidekiq requires connection to the [Redis](#configure-redis), [PostgreSQL](#configure-postgresql) and [Gitaly](#configure-gitaly) instances. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. - `10.6.0.101`: Sidekiq 1 - `10.6.0.102`: Sidekiq 2 @@ -1864,7 +1866,9 @@ run [multiple Sidekiq processes](../operations/extra_sidekiq_processes.md). ## Configure GitLab Rails This section describes how to configure the GitLab application (Rails) component. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. The following IPs will be used as an example: @@ -2015,48 +2019,7 @@ On each node perform the following: 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. -1. If you're not using NFS, [enable incremental logging](#enable-incremental-logging). - -1. If you're [using NFS](#configure-nfs-optional): - 1. If necessary, install the NFS client utility packages using the following - commands: - - ```shell - # Ubuntu/Debian - apt-get install nfs-common - - # CentOS/Red Hat - yum install nfs-utils nfs-utils-lib - ``` - - 1. Specify the necessary NFS mounts in `/etc/fstab`. - The exact contents of `/etc/fstab` will depend on how you chose - to configure your NFS server. See the [NFS documentation](../nfs.md) - for examples and the various options. - - 1. Create the shared directories. These may be different depending on your NFS - mount locations. - - ```shell - mkdir -p /var/opt/gitlab/.ssh /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-ci/builds /var/opt/gitlab/git-data - ``` - - 1. Edit `/etc/gitlab/gitlab.rb` and use the following configuration: - - ```ruby - ## Prevent GitLab from starting if NFS data mounts are not available - high_availability['mountpoint'] = '/var/opt/gitlab/git-data' - - ## Ensure UIDs and GIDs match between servers for permissions via NFS - user['uid'] = 9000 - user['gid'] = 9000 - web_server['uid'] = 9001 - web_server['gid'] = 9001 - registry['uid'] = 9002 - registry['gid'] = 9002 - ``` - - 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +1. [Enable incremental logging](#enable-incremental-logging), unless you are using [NFS](#configure-nfs-optional). 1. Confirm the node can connect to Gitaly: diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 735072e7995..7d67ac48b73 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -1699,7 +1699,9 @@ To configure Praefect with TLS: Sidekiq requires connection to the [Redis](#configure-redis), [PostgreSQL](#configure-postgresql) and [Gitaly](#configure-gitaly) instances. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. - `10.6.0.101`: Sidekiq 1 - `10.6.0.102`: Sidekiq 2 @@ -1867,7 +1869,9 @@ run [multiple Sidekiq processes](../operations/extra_sidekiq_processes.md). ## Configure GitLab Rails This section describes how to configure the GitLab application (Rails) component. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. The following IPs will be used as an example: @@ -2020,48 +2024,8 @@ On each node perform the following: 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. -1. If you're not using NFS, [enable incremental logging](#enable-incremental-logging). +1. [Enable incremental logging](#enable-incremental-logging), unless you are using [NFS](#configure-nfs-optional). -1. If you're [using NFS](#configure-nfs-optional): - 1. If necessary, install the NFS client utility packages using the following - commands: - - ```shell - # Ubuntu/Debian - apt-get install nfs-common - - # CentOS/Red Hat - yum install nfs-utils nfs-utils-lib - ``` - - 1. Specify the necessary NFS mounts in `/etc/fstab`. - The exact contents of `/etc/fstab` will depend on how you chose - to configure your NFS server. See the [NFS documentation](../nfs.md) - for examples and the various options. - - 1. Create the shared directories. These may be different depending on your NFS - mount locations. - - ```shell - mkdir -p /var/opt/gitlab/.ssh /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-ci/builds /var/opt/gitlab/git-data - ``` - - 1. Edit `/etc/gitlab/gitlab.rb` and use the following configuration: - - ```ruby - ## Prevent GitLab from starting if NFS data mounts are not available - high_availability['mountpoint'] = '/var/opt/gitlab/git-data' - - ## Ensure UIDs and GIDs match between servers for permissions via NFS - user['uid'] = 9000 - user['gid'] = 9000 - web_server['uid'] = 9001 - web_server['gid'] = 9001 - registry['uid'] = 9002 - registry['gid'] = 9002 - ``` - - 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Confirm the node can connect to Gitaly: ```shell diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 0a779d10b44..61ea435f63f 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -592,31 +592,6 @@ but this is dependent on workload. On each node perform the following: -1. If you're [using NFS](#configure-nfs-optional): - - 1. If necessary, install the NFS client utility packages using the following - commands: - - ```shell - # Ubuntu/Debian - apt-get install nfs-common - - # CentOS/Red Hat - yum install nfs-utils nfs-utils-lib - ``` - - 1. Specify the necessary NFS mounts in `/etc/fstab`. - The exact contents of `/etc/fstab` will depend on how you chose - to configure your NFS server. See the [NFS documentation](../nfs.md) - for examples and the various options. - - 1. Create the shared directories. These may be different depending on your NFS - mount locations. - - ```shell - mkdir -p /var/opt/gitlab/.ssh /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-ci/builds /var/opt/gitlab/git-data - ``` - 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab package of your choice. Be sure to follow _only_ installation steps 1 and 2 on the page. @@ -745,9 +720,10 @@ On each node perform the following: 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. -1. If you're not using NFS, [enable incremental logging](#enable-incremental-logging). +1. [Enable incremental logging](#enable-incremental-logging), unless you are using [NFS](#configure-nfs-optional). 1. Run `sudo gitlab-rake gitlab:gitaly:check` to confirm the node can connect to Gitaly. + 1. Tail the logs to see the requests: ```shell diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 801eeb99720..7484fafe1b0 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -1639,7 +1639,9 @@ To configure Praefect with TLS: Sidekiq requires connection to the [Redis](#configure-redis), [PostgreSQL](#configure-postgresql) and [Gitaly](#configure-gitaly) instances. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. The following IPs will be used as an example: @@ -1806,35 +1808,12 @@ run [multiple Sidekiq processes](../operations/extra_sidekiq_processes.md). ## Configure GitLab Rails This section describes how to configure the GitLab application (Rails) component. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. On each node perform the following: -1. If you're [using NFS](#configure-nfs-optional): - - 1. If necessary, install the NFS client utility packages using the following - commands: - - ```shell - # Ubuntu/Debian - apt-get install nfs-common - - # CentOS/Red Hat - yum install nfs-utils nfs-utils-lib - ``` - - 1. Specify the necessary NFS mounts in `/etc/fstab`. - The exact contents of `/etc/fstab` will depend on how you chose - to configure your NFS server. See the [NFS documentation](../nfs.md) - for examples and the various options. - - 1. Create the shared directories. These may be different depending on your NFS - mount locations. - - ```shell - mkdir -p /var/opt/gitlab/.ssh /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-ci/builds /var/opt/gitlab/git-data - ``` - 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab package of your choice. Be sure to follow _only_ installation steps 1 and 2 on the page. @@ -1982,7 +1961,7 @@ On each node perform the following: 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. -1. If you're not using NFS, [enable incremental logging](#enable-incremental-logging). +1. [Enable incremental logging](#enable-incremental-logging), unless you are using [NFS](#configure-nfs-optional). 1. Run `sudo gitlab-rake gitlab:gitaly:check` to confirm the node can connect to Gitaly. diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index df46aaaa674..88fc3649b3f 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -1709,7 +1709,9 @@ To configure Praefect with TLS: Sidekiq requires connection to the [Redis](#configure-redis), [PostgreSQL](#configure-postgresql) and [Gitaly](#configure-gitaly) instances. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. - `10.6.0.101`: Sidekiq 1 - `10.6.0.102`: Sidekiq 2 @@ -1877,7 +1879,9 @@ run [multiple Sidekiq processes](../operations/extra_sidekiq_processes.md). ## Configure GitLab Rails This section describes how to configure the GitLab application (Rails) component. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. The following IPs will be used as an example: @@ -2037,48 +2041,8 @@ On each node perform the following: 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. -1. If you're not using NFS, [enable incremental logging](#enable-incremental-logging). +1. [Enable incremental logging](#enable-incremental-logging), unless you are using [NFS](#configure-nfs-optional). -1. If you're [using NFS](#configure-nfs-optional): - 1. If necessary, install the NFS client utility packages using the following - commands: - - ```shell - # Ubuntu/Debian - apt-get install nfs-common - - # CentOS/Red Hat - yum install nfs-utils nfs-utils-lib - ``` - - 1. Specify the necessary NFS mounts in `/etc/fstab`. - The exact contents of `/etc/fstab` will depend on how you chose - to configure your NFS server. See the [NFS documentation](../nfs.md) - for examples and the various options. - - 1. Create the shared directories. These may be different depending on your NFS - mount locations. - - ```shell - mkdir -p /var/opt/gitlab/.ssh /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-ci/builds /var/opt/gitlab/git-data - ``` - - 1. Edit `/etc/gitlab/gitlab.rb` and use the following configuration: - - ```ruby - ## Prevent GitLab from starting if NFS data mounts are not available - high_availability['mountpoint'] = '/var/opt/gitlab/git-data' - - ## Ensure UIDs and GIDs match between servers for permissions via NFS - user['uid'] = 9000 - user['gid'] = 9000 - web_server['uid'] = 9001 - web_server['gid'] = 9001 - registry['uid'] = 9002 - registry['gid'] = 9002 - ``` - - 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Confirm the node can connect to Gitaly: ```shell diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index befaf6ba804..c8cf35a2e59 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -1636,7 +1636,9 @@ To configure Praefect with TLS: Sidekiq requires connection to the [Redis](#configure-redis), [PostgreSQL](#configure-postgresql) and [Gitaly](#configure-gitaly) instances. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. - `10.6.0.71`: Sidekiq 1 - `10.6.0.72`: Sidekiq 2 @@ -1802,35 +1804,12 @@ run [multiple Sidekiq processes](../operations/extra_sidekiq_processes.md). ## Configure GitLab Rails This section describes how to configure the GitLab application (Rails) component. -[Object storage](#configure-the-object-storage) is also required to be configured. +Since it's recommended to use [Object storage](#configure-the-object-storage) +over [NFS](#configure-nfs-optional) for data objects, the following examples +include the Object storage configuration. On each node perform the following: -1. If you're [using NFS](#configure-nfs-optional): - - 1. If necessary, install the NFS client utility packages using the following - commands: - - ```shell - # Ubuntu/Debian - apt-get install nfs-common - - # CentOS/Red Hat - yum install nfs-utils nfs-utils-lib - ``` - - 1. Specify the necessary NFS mounts in `/etc/fstab`. - The exact contents of `/etc/fstab` depends on how you chose - to configure your NFS server. See the [NFS documentation](../nfs.md) - for examples and the various options. - - 1. Create the shared directories. These may be different depending on your NFS - mount locations. - - ```shell - mkdir -p /var/opt/gitlab/.ssh /var/opt/gitlab/gitlab-rails/uploads /var/opt/gitlab/gitlab-rails/shared /var/opt/gitlab/gitlab-ci/builds /var/opt/gitlab/git-data - ``` - 1. [Download and install](https://about.gitlab.com/install/) the Omnibus GitLab package of your choice. Be sure to follow _only_ installation steps 1 and 2 on the page. @@ -1981,9 +1960,10 @@ On each node perform the following: 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. -1. If you're not using NFS, [enable incremental logging](#enable-incremental-logging). +1. [Enable incremental logging](#enable-incremental-logging), unless you are using [NFS](#configure-nfs-optional). 1. Run `sudo gitlab-rake gitlab:gitaly:check` to confirm the node can connect to Gitaly. + 1. Tail the logs to see the requests: ```shell diff --git a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md index 4358af585df..e5ee6051000 100644 --- a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md +++ b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md @@ -779,3 +779,24 @@ Prints the metrics saved in `conversational_development_index_metrics`. ```shell rake gitlab:usage_data:generate_and_send ``` + +## GraphQL + +Call a [GraphQL](../../api/graphql/getting_started.md) endpoint through the Rails console: + +```ruby +query = <<~EOQ +query securityGetProjects($search: String!) { + projects(search: $search) { + nodes { + path + } + } +} +EOQ + +variables = { "search": "gitlab" } + +result = GitlabSchema.execute(query, variables: variables, context: { current_user: current_user }) +result.to_h +``` diff --git a/doc/api/users.md b/doc/api/users.md index 67fa9b60f3c..4a924f3b5f3 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -106,7 +106,8 @@ GET /users?without_project_bots=true ### For administrators **(FREE SELF)** -> The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. +> - The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. +> - The `created_by` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93092) in GitLab 15.6. ```plaintext GET /users @@ -161,7 +162,8 @@ GET /users "private_profile": false, "current_sign_in_ip": "196.165.1.102", "last_sign_in_ip": "172.127.2.22", - "namespace_id": 1 + "namespace_id": 1, + "created_by": null }, { "id": 2, @@ -196,7 +198,8 @@ GET /users "private_profile": false, "current_sign_in_ip": "10.165.1.102", "last_sign_in_ip": "172.127.2.22", - "namespace_id": 2 + "namespace_id": 2, + "created_by": null } ] ``` @@ -269,6 +272,13 @@ You can include the users' [custom attributes](custom_attributes.md) in the resp GET /users?with_custom_attributes=true ``` +You can use the `created_by` parameter to see if a user account was created: + +- [Manually by an administrator](../user/profile/account/create_accounts.md#create-users-in-admin-area). +- As a [project bot user](../user/project/settings/project_access_tokens.md#bot-users-for-projects). + +If the returned value is `null`, the account was created by a user who registered an account themselves. + ## Single user Get a single user. @@ -315,7 +325,8 @@ Parameters: ### For administrators **(FREE SELF)** -> The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. +> - The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. +> - The `created_by` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93092) in GitLab 15.6. ```plaintext GET /users/:id @@ -378,7 +389,8 @@ Example Responses: "plan": "gold", "trial": true, "sign_in_count": 1337, - "namespace_id": 1 + "namespace_id": 1, + "created_by": null } ``` @@ -419,6 +431,13 @@ see the `group_saml` option and `provisioned_by_group_id` parameter: } ``` +Administrators can use the `created_by` parameter to see if a user account was created: + +- [Manually by an administrator](../user/profile/account/create_accounts.md#create-users-in-admin-area). +- As a [project bot user](../user/project/settings/project_access_tokens.md#bot-users-for-projects). + +If the returned value is `null`, the account was created by a user who registered an account themselves. + You can include the user's [custom attributes](custom_attributes.md) in the response with: ```plaintext @@ -630,7 +649,8 @@ Users on [GitLab Premium or higher](https://about.gitlab.com/pricing/) also see ### For administrators **(FREE SELF)** -> The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. +> - The `namespace_id` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/82045) in GitLab 14.10. +> - The `created_by` field in the response was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/93092) in GitLab 15.6. ```plaintext GET /user @@ -683,6 +703,7 @@ Parameters: "current_sign_in_ip": "196.165.1.102", "last_sign_in_ip": "172.127.2.22", "namespace_id": 1, + "created_by": null, "note": null } ``` diff --git a/doc/architecture/blueprints/ci_data_decay/pipeline_partitioning.md b/doc/architecture/blueprints/ci_data_decay/pipeline_partitioning.md index 52642e04155..5f907ecdaa4 100644 --- a/doc/architecture/blueprints/ci_data_decay/pipeline_partitioning.md +++ b/doc/architecture/blueprints/ci_data_decay/pipeline_partitioning.md @@ -281,11 +281,17 @@ declarative partitioning. Doing that will also allow us to use a Unified Resource Identifier for partitioned resources, that will contain a pointer to a pipeline ID, we could -then use to efficiently lookup a partition the resource is stored in. We could -use an ID like `1e240-5ba0` for pipeline `123456`, build `23456`. If we decide -to update the primary identifier of a partitioned resource (today it is just a -big integer) it is important to design a system that is resilient to migrating -data between partitions, to avoid changing idenfiers when rebalancing happens. +then use to efficiently lookup a partition the resource is stored in. It might +be important when a resources can be directly referenced by an URL, in UI or +API. We could use an ID like `1e240-5ba0` for pipeline `123456`, build `23456`. +Using a dash `-` can prevent an identifier from being highlighted and copied +with a mouse double-click. If we want to avoid this problem, we can use any +character of written representation that is not present in base-16 numeral +system - any letter from `g` to `z` in Latin alphabet, for example `x`. In that +case an example of an URI would look like `1e240x5ba0`. If we decide to update +the primary identifier of a partitioned resource (today it is just a big +integer) it is important to design a system that is resilient to migrating data +between partitions, to avoid changing idenfiers when rebalancing happens. `ci_partitions` table will store information about a partition identifier, pipeline ids range it is valid for and whether the partitions have been diff --git a/doc/architecture/blueprints/runner_scaling/index.md b/doc/architecture/blueprints/runner_scaling/index.md index f46811f6ece..f7b31957188 100644 --- a/doc/architecture/blueprints/runner_scaling/index.md +++ b/doc/architecture/blueprints/runner_scaling/index.md @@ -43,10 +43,10 @@ to be able to keep using this and ship fixes and updates needed for our use case and the documentation for it has been removed from the official page. This means that the original reason to use Docker Machine is no longer valid too. -To keep supporting our customers and the wider community we need to design a -new mechanism for GitLab Runner auto-scaling. It not only needs to support -auto-scaling, but it also needs to do that in the way to enable us to build on -top of it to improve efficiency, reliability and availability. +To keep supporting our customers and the wider community and to improve our SaaS runners +maintenance we need to design a new mechanism for GitLab Runner auto-scaling. It not only +needs to support auto-scaling, but it also needs to do that in the way to enable us to +build on top of it to improve efficiency, reliability and availability. We call this new mechanism the "next GitLab Runner Scaling architecture". @@ -62,6 +62,66 @@ subject to change or delay. The development, release and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc._ +## Continuing building on Docker Machine + +At this moment one of our core products - GitLab Runner - and one of its most +important features - ability to auto-scale job execution environments - depends +on an external product that is abandoned. + +Docker Machine project itself is also hard to maintain. Its design starts to +show its age, which makes it hard to bring new features and fixes. A huge +codebase that it brings with a lack of internal knowledge about it makes it +hard for our maintainers to support and properly handle incoming feature +requests and community contributions. + +Docker Machine and it integrated 20+ drivers for cloud and virtualization +providers creates also another subset of problems, like: + +- Each cloud/virtualization environment brings features that come and go + and we would need to maintain support for them (add new features, fix + bugs). + +- We basically need to become experts for each of the virtualization/cloud + provider to properly support integration with their API, + +- Every single provider that Docker Machine integrates with has its + bugs, security releases, vulnerabilities - to maintain the project properly + we would need to be on top of all of that and handle updates whenever + they are needed. + +Another problem is the fact that Docker Machine, from its beginnings, was +focused on managing Linux based instances only. Despite that at some moment +Docker got official and native integration on Windows, Docker Machine never +followed this step. Nor its designed to make such integration easy. + +There is also no support for MacOS. This one is obvious - Docker Machine is a +tool to maintain hosts for Docker Engine and there is no native Docker Engine +for MacOS. And by native we mean MacOS containers executed within MacOS +operating system. Docker for MacOS product is not a native support - it's just +a tooling and a virtualized Linux instance installed with it that makes it +easier to develop **Linux containers** on MacOS development instances. + +This means that only one of three of our officially supported platforms - +Linux, Windows and MacOS - have a fully-featured support for CI/CD +auto-scaling. For Windows there is a possibility to use Kubernetes (which in +some cases have limitations) and maybe with a lot of effort we could bring +support for Windows into Docker Machine. But for MacOS, there is no +auto-scaling solution provided natively by GitLab Runner. + +This is a huge limitation for our users and a frequently requested feature. +It's also a limitation for our SaaS runners offering. We've maintained to +create some sort of auto-scaling for our SaaS Windows and SaaS MacOS runners +hacking around Custom executor. But experiences from past three years show +that it's not the best way of doing this. And yet, after this time, Windows +and MacOS runners autoscaling lacks a lot of performance and feature support +that we have with our SaaS Linux runners. + +To keep supporting our customers and the wider community and to improve our +SaaS runners maintenance we need to design a new mechanism for GitLab Runner +auto-scaling. It not only needs to support auto-scaling, but it also needs to +do that in the way to enable us to build on top of it to improve efficiency, +reliability and availability. + ## Proposal Currently, GitLab Runner auto-scaling can be configured in a few ways. Some @@ -246,9 +306,17 @@ abstraction. - Design the new auto-scaling architecture aiming for having more choices and flexibility in the future, instead of imposing new constraints. - Design the new auto-scaling architecture to experiment with running multiple - jobs in parallel, on a single machine. + jobs in parallel, on a single machine. - Design the new provisioning architecture to replace Docker Machine in a way that the wider community can easily build on top of the new abstractions. +- New auto-scaling method should become a core component of GitLab Runner product so that + we can simplify maintenance, use the same tooling, test configuration and Go language + setup as we do in our other main products. +- It should support multiple job execution environments - not only Docker containers + on Linux operating system. + + The best design would be to bring auto-scaling as a feature wrapped around + our current executors like Docker or Shell. #### Principles for the new plugin system @@ -270,10 +338,14 @@ abstraction. - Favor gRPC communication between a plugin and GitLab Runner. - Make it possible to version communication interface and support many versions. - Make Go a primary language for writing plugins but accept other languages too. -- Prefer a GitLab job-aware autoscaler to provider specific autoscalers. Cloud provider - autoscalers don't know which VM to delete when scaling down so they make sub-optimal - decisions. Rather than teaching all autoscalers about GitLab jobs, we prefer to - have one, GitLab-owned autoscaler (not in the plugin). +- Autoscaling mechanism should be fully owned by GitLab. + + Cloud provider autoscalers don't know which VM to delete when scaling down so + they make sub-optimal decisions. Rather than teaching all autoscalers about GitLab + jobs, we prefer to have one, GitLab-owned autoscaler (not in the plugin). + + It will also ensure that we can shape the future of the mechanism and make decisions + that fit our needs and requirements. ## Plugin boundary proposals @@ -350,7 +422,7 @@ Proposal: -| Role | Who +| Role | Who | |------------------------------|-------------------------------------------------| | Authors | Grzegorz Bizon, Tomasz Maczukin, Joseph Burnett | | Architecture Evolution Coach | Kamil TrzciƄski | @@ -360,16 +432,16 @@ Proposal: DRIs: -| Role | Who -|------------------------------|------------------------| -| Leadership | Elliot Rushton | -| Product | Darren Eastman | -| Engineering | Tomasz Maczukin | +| Role | Who | +|-------------|-----------------| +| Leadership | Elliot Rushton | +| Product | Darren Eastman | +| Engineering | Tomasz Maczukin | Domain experts: -| Area | Who -|------------------------------|------------------------| -| Domain Expert / Runner | Arran Walker | +| Area | Who | +|------------------------|--------------| +| Domain Expert / Runner | Arran Walker | diff --git a/doc/ci/git_submodules.md b/doc/ci/git_submodules.md index 2d6dfcdda2d..ee9d15894fe 100644 --- a/doc/ci/git_submodules.md +++ b/doc/ci/git_submodules.md @@ -60,6 +60,14 @@ To make submodules work correctly in CI/CD jobs: GIT_SUBMODULE_STRATEGY: recursive ``` +1. You can filter or exclude specific submodules to control which submodules will be synced using + [`GIT_SUBMODULE_PATHS`](runners/configure_runners.md#git-submodule-paths). + + ```yaml + variables: + GIT_SUBMODULE_PATHS: submoduleA submoduleB + ``` + 1. You can provide additional flags to control advanced checkout behavior using [`GIT_SUBMODULE_UPDATE_FLAGS`](runners/configure_runners.md#git-submodule-update-flags). diff --git a/doc/ci/runners/configure_runners.md b/doc/ci/runners/configure_runners.md index 28481a7e7ab..19e0c1e3c81 100644 --- a/doc/ci/runners/configure_runners.md +++ b/doc/ci/runners/configure_runners.md @@ -302,6 +302,7 @@ globally or for individual jobs: - [`GIT_CHECKOUT`](#git-checkout) - [`GIT_CLEAN_FLAGS`](#git-clean-flags) - [`GIT_FETCH_EXTRA_FLAGS`](#git-fetch-extra-flags) +- [`GIT_SUBMODULE_PATHS`](#git-submodule-paths) - [`GIT_SUBMODULE_UPDATE_FLAGS`](#git-submodule-update-flags) - [`GIT_DEPTH`](#shallow-cloning) (shallow cloning) - [`GIT_CLONE_PATH`](#custom-build-directories) (custom build directories) @@ -488,6 +489,32 @@ git fetch origin $REFSPECS --depth 50 --prune Where `$REFSPECS` is a value provided to the runner internally by GitLab. +### Git submodule paths + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/2249) in GitLab Runner 14.0. + +Use the `GIT_SUBMODULE_PATHS` variable to control which submodules have to be synced or updated. +You can set it globally or per-job in the [`variables`](../yaml/index.md#variables) section. + +This variable can be very useful for projects which have a large number of submodules which not all of them +need to be synced or updated in all CI jobs. + +The path syntax is the same as [`git submodule`](https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-ltpathgt82308203): + +- To sync and update specific paths: + + ```yaml + variables: + GIT_SUBMODULE_PATHS: submoduleA submoduleB + ``` + +- To exclude specific paths: + + ```yaml + variables: + GIT_SUBMODULE_PATHS: :(exclude)submoduleA :(exclude)submoduleB + ``` + ### Git submodule update flags > [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/3192) in GitLab Runner 14.8. diff --git a/doc/development/database/foreign_keys.md b/doc/development/database/foreign_keys.md index dd0fc6f8446..d9506ae614a 100644 --- a/doc/development/database/foreign_keys.md +++ b/doc/development/database/foreign_keys.md @@ -4,7 +4,7 @@ group: Database info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Foreign Keys & Associations +# Foreign keys and associations When adding an association to a model you must also add a foreign key. For example, say you have the following model: @@ -20,7 +20,7 @@ that data consistency is enforced on database level. Foreign keys also mean that the database can very quickly remove associated data (for example, when removing a user), instead of Rails having to do this. -## Adding Foreign Keys In Migrations +## Adding foreign keys in migrations Foreign keys can be added concurrently using `add_concurrent_foreign_key` as defined in `Gitlab::Database::MigrationHelpers`. See the @@ -31,7 +31,7 @@ you have removed any orphaned rows. The method `add_concurrent_foreign_key` does not take care of this so you must do so manually. See [adding foreign key constraint to an existing column](add_foreign_key_to_existing_column.md). -## Updating Foreign Keys In Migrations +## Updating foreign keys in migrations Sometimes a foreign key constraint must be changed, preserving the column but updating the constraint condition. For example, moving from @@ -45,64 +45,64 @@ To replace a foreign key: 1. [Add the new foreign key without validation](add_foreign_key_to_existing_column.md#prevent-invalid-records) - The name of the foreign key constraint must be changed to add a new - foreign key before removing the old one. + The name of the foreign key constraint must be changed to add a new + foreign key before removing the old one. - ```ruby - class ReplaceFkOnPackagesPackagesProjectId < Gitlab::Database::Migration[2.0] - disable_ddl_transaction! + ```ruby + class ReplaceFkOnPackagesPackagesProjectId < Gitlab::Database::Migration[2.0] + disable_ddl_transaction! - NEW_CONSTRAINT_NAME = 'fk_new' + NEW_CONSTRAINT_NAME = 'fk_new' - def up - add_concurrent_foreign_key(:packages_packages, :projects, column: :project_id, on_delete: :nullify, validate: false, name: NEW_CONSTRAINT_NAME) - end + def up + add_concurrent_foreign_key(:packages_packages, :projects, column: :project_id, on_delete: :nullify, validate: false, name: NEW_CONSTRAINT_NAME) + end - def down - with_lock_retries do - remove_foreign_key_if_exists(:packages_packages, column: :project_id, on_delete: :nullify, name: NEW_CONSTRAINT_NAME) - end - end - end - ``` + def down + with_lock_retries do + remove_foreign_key_if_exists(:packages_packages, column: :project_id, on_delete: :nullify, name: NEW_CONSTRAINT_NAME) + end + end + end + ``` 1. [Validate the new foreign key](add_foreign_key_to_existing_column.md#validate-the-foreign-key) - ```ruby - class ValidateFkNew < Gitlab::Database::Migration[2.0] - NEW_CONSTRAINT_NAME = 'fk_new' + ```ruby + class ValidateFkNew < Gitlab::Database::Migration[2.0] + NEW_CONSTRAINT_NAME = 'fk_new' - # foreign key added in - def up - validate_foreign_key(:packages_packages, name: NEW_CONSTRAINT_NAME) - end + # foreign key added in + def up + validate_foreign_key(:packages_packages, name: NEW_CONSTRAINT_NAME) + end - def down - # no-op - end - end - ``` + def down + # no-op + end + end + ``` 1. Remove the old foreign key: - ```ruby - class RemoveFkOld < Gitlab::Database::Migration[2.0] - OLD_CONSTRAINT_NAME = 'fk_old' + ```ruby + class RemoveFkOld < Gitlab::Database::Migration[2.0] + OLD_CONSTRAINT_NAME = 'fk_old' - # new foreign key added in - # and validated in - def up - remove_foreign_key_if_exists(:packages_packages, column: :project_id, on_delete: :cascade, name: OLD_CONSTRAINT_NAME) - end + # new foreign key added in + # and validated in + def up + remove_foreign_key_if_exists(:packages_packages, column: :project_id, on_delete: :cascade, name: OLD_CONSTRAINT_NAME) + end - def down - # Validation is skipped here, so if rolled back, this will need to be revalidated in a separate migration - add_concurrent_foreign_key(:packages_packages, :projects, column: :project_id, on_delete: :cascade, validate: false, name: OLD_CONSTRAINT_NAME) - end - end - ``` + def down + # Validation is skipped here, so if rolled back, this will need to be revalidated in a separate migration + add_concurrent_foreign_key(:packages_packages, :projects, column: :project_id, on_delete: :cascade, validate: false, name: OLD_CONSTRAINT_NAME) + end + end + ``` -## Cascading Deletes +## Cascading deletes Every foreign key must define an `ON DELETE` clause, and in 99% of the cases this should be set to `CASCADE`. @@ -124,7 +124,7 @@ have a foreign key constraint. So if that spec fails, don't add the column to `IGNORED_FK_COLUMNS`, but instead add the FK constraint, or consider naming it differently. -## Dependent Removals +## Dependent removals Don't define options such as `dependent: :destroy` or `dependent: :delete` when defining an association. Defining these options means Rails handles the @@ -182,9 +182,9 @@ create_table :user_configs, id: false do |t| end ``` -Setting `default: nil` ensures a primary key sequence is not created, and since the primary key +Setting `default: nil` ensures a primary key sequence is not created, and because the primary key automatically gets an index, we set `index: false` to avoid creating a duplicate. -You also need to add the new primary key to the model: +You must also add the new primary key to the model: ```ruby class UserConfig < ActiveRecord::Base diff --git a/doc/development/fe_guide/customizable_dashboards.md b/doc/development/fe_guide/customizable_dashboards.md new file mode 100644 index 00000000000..38ee750d421 --- /dev/null +++ b/doc/development/fe_guide/customizable_dashboards.md @@ -0,0 +1,99 @@ +--- +stage: Analytics +group: Product Analytics +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Customizable dashboards **(PREMIUM)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98610) in GitLab 15.5 as an [Alpha feature](../../policy/alpha-beta-support.md#alpha-features). + +Customizable dashboards provide a dashboard structure that allows users to create +their own dashboards and commit the structure to a repository. + +## Usage + +To use customizable dashboards: + +1. Create your dashboard component. +1. Render an instance of `CustomizableDashboard`. +1. Pass a list of widgets to render. + +For example, a customizable dashboard for users over time: + +```vue + + + +``` + +The widgets data can be retrieved from a file or API request, or imported through HTML data attributes. + +For each widget, a `component` is defined. Each `component` is a component declaration and should be included in +[`vue_shared/components/customizable_dashboard/widgets_base.vue`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/app/assets/javascripts/vue_shared/components/customizable_dashboard/widgets_base.vue) +as a dynamic import, to keep the memory usage down until it is used. + +For example: + +```javascript +components: { + CubeLineChart: () => import('ee/product_analytics/dashboards/components/widgets/cube_line_chart.vue') +} +``` diff --git a/doc/development/feature_development.md b/doc/development/feature_development.md index 32ed54f6fd8..760ba033633 100644 --- a/doc/development/feature_development.md +++ b/doc/development/feature_development.md @@ -114,6 +114,7 @@ Consult these topics for information on contributing to specific GitLab features - [Cached queries guidelines](cached_queries.md), for tracking down N+1 queries masked by query caching, memory profiling and why should we avoid cached queries. +- [JSON guidelines](json.md) for how to handle JSON in a performant manner. ## Database guides diff --git a/doc/development/json.md b/doc/development/json.md new file mode 100644 index 00000000000..8a2575401fb --- /dev/null +++ b/doc/development/json.md @@ -0,0 +1,46 @@ +--- +stage: none +group: unassigned +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# JSON Guidelines + +At GitLab we handle a lot of JSON data. To best ensure we remain performant +when handling large JSON encodes or decodes, we use our own JSON class +instead of the default methods. + +## `Gitlab::Json` + +This class should be used in place of any calls to the default `JSON` class, +`.to_json` calls, and the like. It implements the majority of the public +methods provided by `JSON`, such as `.parse`, `.generate`, `.dump`, etc, and +should be entirely identical in its response. + +The difference being that by sending all JSON handling through `Gitlab::Json` +we can change the gem being used in the background. We use `oj` +instead of the `json` gem, which uses C extensions and is therefore notably +faster. + +This class came into existence because, due to the age of the GitLab application, +it was proving impossible to just replace the `json` gem with `oj` by default because: + +- The number of tests with exact expectations of the responses. +- The subtle variances between different JSON processors, particularly + around formatting. + +The `Gitlab::Json` class takes this into account and can +vary the adapter based on the use case, and account for outdated formatting +expectations. + +## `Gitlab::Json::PrecompiledJson` + +This class is used by our hooks into the Grape framework to ensure that +already-generated JSON is not then run through JSON generation +a second time when returning the response. + +## `Gitlab::Json::LimitedEncoder` + +This class can be used to generate JSON but fail with an error if the +resulting JSON would be too large. The default limit for the `.encode` +method is 25 MB, but this can be customized when using the method. diff --git a/doc/subscriptions/index.md b/doc/subscriptions/index.md index 78b9a586c0b..e6dcead3a52 100644 --- a/doc/subscriptions/index.md +++ b/doc/subscriptions/index.md @@ -46,10 +46,7 @@ A new subscription must be purchased and applied as needed. Pricing is [tier-based](https://about.gitlab.com/pricing/), allowing you to choose the features which fit your budget. For information on what features are available -at each tier for each product, see: - -- [GitLab SaaS feature comparison](https://about.gitlab.com/pricing/gitlab-com/feature-comparison/) -- [GitLab self-managed feature comparison](https://about.gitlab.com/pricing/self-managed/feature-comparison/) +at each tier for each product, see: [GitLab self-managed feature comparison](https://about.gitlab.com/pricing/feature-comparison/) ## Find your subscription diff --git a/glfm_specification/output/spec.html b/glfm_specification/output/spec.html index b8315390200..e57cd344618 100644 --- a/glfm_specification/output/spec.html +++ b/glfm_specification/output/spec.html @@ -1 +1,9219 @@ -PLACEHOLDER FILE. Actual contents will be added in a future MR. +
+
title: GitLab Flavored Markdown (GLFM) Spec
+version: alpha
+ +
+

+Introduction

+

TODO: Write a GitLab-specific version of the GitHub Flavored Markdown intro section.

+

+Preliminaries

+

+Characters and lines

+

Any sequence of [characters] is a valid CommonMark +document.

+

A character is a Unicode code point. Although some +code points (for example, combining accents) do not correspond to +characters in an intuitive sense, all code points count as characters +for purposes of this spec.

+

This spec does not specify an encoding; it thinks of lines as composed +of [characters] rather than bytes. A conforming parser may be limited +to a certain encoding.

+

A line is a sequence of zero or more [characters] +other than newline (U+000A) or carriage return (U+000D), +followed by a [line ending] or by the end of file.

+

A line ending is a newline (U+000A), a carriage return +(U+000D) not followed by a newline, or a carriage return and a +following newline.

+

A line containing no characters, or a line containing only spaces +(U+0020) or tabs (U+0009), is called a blank line.

+

The following definitions of character classes will be used in this spec:

+

A whitespace character is a space +(U+0020), tab (U+0009), newline (U+000A), line tabulation (U+000B), +form feed (U+000C), or carriage return (U+000D).

+

Whitespace is a sequence of one or more [whitespace +characters].

+

A Unicode whitespace character is +any code point in the Unicode Zs general category, or a tab (U+0009), +carriage return (U+000D), newline (U+000A), or form feed +(U+000C).

+

Unicode whitespace is a sequence of one +or more [Unicode whitespace characters].

+

A space is U+0020.

+

A non-whitespace character is any character +that is not a [whitespace character].

+

An ASCII punctuation character +is !, ", #, $, %, &, ', (, ), +*, +, ,, -, ., / (U+0021–2F), +:, ;, <, =, >, ?, @ (U+003A–0040), +[, \, ], ^, _, ` (U+005B–0060), +{, |, }, or ~ (U+007B–007E).

+

A punctuation character is an [ASCII +punctuation character] or anything in +the general Unicode categories Pc, Pd, Pe, Pf, Pi, Po, or Ps.

+

+Tabs

+

Tabs in lines are not expanded to [spaces]. However, +in contexts where whitespace helps to define block structure, +tabs behave as if they were replaced by spaces with a tab stop +of 4 characters.

+

Thus, for example, a tab can be used instead of four spaces +in an indented code block. (Note, however, that internal +tabs are passed through as literal tabs, not expanded to +spaces.)

+
+
→foo→baz→→bim
+.
+<pre><code>foo→baz→→bim
+</code></pre>
+ +
+
+
  →foo→baz→→bim
+.
+<pre><code>foo→baz→→bim
+</code></pre>
+ +
+
+
    a→a
+    ᜐ→a
+.
+<pre><code>a→a
+ᜐ→a
+</code></pre>
+ +
+

In the following example, a continuation paragraph of a list +item is indented with a tab; this has exactly the same effect +as indentation with four spaces would:

+
+
  - foo
+
+→bar
+.
+<ul>
+<li>
+<p>foo</p>
+<p>bar</p>
+</li>
+</ul>
+ +
+
+
- foo
+
+→→bar
+.
+<ul>
+<li>
+<p>foo</p>
+<pre><code>  bar
+</code></pre>
+</li>
+</ul>
+ +
+

Normally the > that begins a block quote may be followed +optionally by a space, which is not considered part of the +content. In the following case > is followed by a tab, +which is treated as if it were expanded into three spaces. +Since one of these spaces is considered part of the +delimiter, foo is considered to be indented six spaces +inside the block quote context, so we get an indented +code block starting with two spaces.

+
+
>→→foo
+.
+<blockquote>
+<pre><code>  foo
+</code></pre>
+</blockquote>
+ +
+
+
-→→foo
+.
+<ul>
+<li>
+<pre><code>  foo
+</code></pre>
+</li>
+</ul>
+ +
+
+
    foo
+→bar
+.
+<pre><code>foo
+bar
+</code></pre>
+ +
+
+
 - foo
+   - bar
+→ - baz
+.
+<ul>
+<li>foo
+<ul>
+<li>bar
+<ul>
+<li>baz</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+ +
+
+
#→Foo
+.
+<h1>Foo</h1>
+ +
+
+
*→*→*→
+.
+<hr />
+ +
+

+Insecure characters

+

For security reasons, the Unicode character U+0000 must be replaced +with the REPLACEMENT CHARACTER (U+FFFD).

+

+Blocks and inlines

+

We can think of a document as a sequence of +blocks---structural elements like paragraphs, block +quotations, lists, headings, rules, and code blocks. Some blocks (like +block quotes and list items) contain other blocks; others (like +headings and paragraphs) contain inline content---text, +links, emphasized text, images, code spans, and so on.

+

+Precedence

+

Indicators of block structure always take precedence over indicators +of inline structure. So, for example, the following is a list with +two items, not a list with one item containing a code span:

+
+
- `one
+- two`
+.
+<ul>
+<li>`one</li>
+<li>two`</li>
+</ul>
+ +
+

This means that parsing can proceed in two steps: first, the block +structure of the document can be discerned; second, text lines inside +paragraphs, headings, and other block constructs can be parsed for inline +structure. The second step requires information about link reference +definitions that will be available only at the end of the first +step. Note that the first step requires processing lines in sequence, +but the second can be parallelized, since the inline parsing of +one block element does not affect the inline parsing of any other.

+

+Container blocks and leaf blocks

+

We can divide blocks into two types: +container blocks, +which can contain other blocks, and leaf blocks, +which cannot.

+

+Leaf blocks

+

This section describes the different kinds of leaf block that make up a +Markdown document.

+

+Thematic breaks

+

A line consisting of 0-3 spaces of indentation, followed by a sequence +of three or more matching -, _, or * characters, each followed +optionally by any number of spaces or tabs, forms a +thematic break.

+
+
***
+---
+___
+.
+<hr />
+<hr />
+<hr />
+ +
+

Wrong characters:

+
+
+++
+.
+<p>+++</p>
+ +
+
+
===
+.
+<p>===</p>
+ +
+

Not enough characters:

+
+
--
+**
+__
+.
+<p>--
+**
+__</p>
+ +
+

One to three spaces indent are allowed:

+
+
 ***
+  ***
+   ***
+.
+<hr />
+<hr />
+<hr />
+ +
+

Four spaces is too many:

+
+
    ***
+.
+<pre><code>***
+</code></pre>
+ +
+
+
Foo
+    ***
+.
+<p>Foo
+***</p>
+ +
+

More than three characters may be used:

+
+
_____________________________________
+.
+<hr />
+ +
+

Spaces are allowed between the characters:

+
+
 - - -
+.
+<hr />
+ +
+
+
 **  * ** * ** * **
+.
+<hr />
+ +
+
+
-     -      -      -
+.
+<hr />
+ +
+

Spaces are allowed at the end:

+
+
- - - -    
+.
+<hr />
+ +
+

However, no other characters may occur in the line:

+
+
_ _ _ _ a
+
+a------
+
+---a---
+.
+<p>_ _ _ _ a</p>
+<p>a------</p>
+<p>---a---</p>
+ +
+

It is required that all of the [non-whitespace characters] be the same. +So, this is not a thematic break:

+
+
 *-*
+.
+<p><em>-</em></p>
+ +
+

Thematic breaks do not need blank lines before or after:

+
+
- foo
+***
+- bar
+.
+<ul>
+<li>foo</li>
+</ul>
+<hr />
+<ul>
+<li>bar</li>
+</ul>
+ +
+

Thematic breaks can interrupt a paragraph:

+
+
Foo
+***
+bar
+.
+<p>Foo</p>
+<hr />
+<p>bar</p>
+ +
+

If a line of dashes that meets the above conditions for being a +thematic break could also be interpreted as the underline of a [setext +heading], the interpretation as a +[setext heading] takes precedence. Thus, for example, +this is a setext heading, not a paragraph followed by a thematic break:

+
+
Foo
+---
+bar
+.
+<h2>Foo</h2>
+<p>bar</p>
+ +
+

When both a thematic break and a list item are possible +interpretations of a line, the thematic break takes precedence:

+
+
* Foo
+* * *
+* Bar
+.
+<ul>
+<li>Foo</li>
+</ul>
+<hr />
+<ul>
+<li>Bar</li>
+</ul>
+ +
+

If you want a thematic break in a list item, use a different bullet:

+
+
- Foo
+- * * *
+.
+<ul>
+<li>Foo</li>
+<li>
+<hr />
+</li>
+</ul>
+ +
+

+ATX headings

+

An ATX heading +consists of a string of characters, parsed as inline content, between an +opening sequence of 1--6 unescaped # characters and an optional +closing sequence of any number of unescaped # characters. +The opening sequence of # characters must be followed by a +[space] or by the end of line. The optional closing sequence of #s must be +preceded by a [space] and may be followed by spaces only. The opening +# character may be indented 0-3 spaces. The raw contents of the +heading are stripped of leading and trailing spaces before being parsed +as inline content. The heading level is equal to the number of # +characters in the opening sequence.

+

Simple headings:

+
+
# foo
+## foo
+### foo
+#### foo
+##### foo
+###### foo
+.
+<h1>foo</h1>
+<h2>foo</h2>
+<h3>foo</h3>
+<h4>foo</h4>
+<h5>foo</h5>
+<h6>foo</h6>
+ +
+

More than six # characters is not a heading:

+
+
####### foo
+.
+<p>####### foo</p>
+ +
+

At least one space is required between the # characters and the +heading's contents, unless the heading is empty. Note that many +implementations currently do not require the space. However, the +space was required by the +original ATX implementation, +and it helps prevent things like the following from being parsed as +headings:

+
+
#5 bolt
+
+#hashtag
+.
+<p>#5 bolt</p>
+<p>#hashtag</p>
+ +
+

This is not a heading, because the first # is escaped:

+
+
\## foo
+.
+<p>## foo</p>
+ +
+

Contents are parsed as inlines:

+
+
# foo *bar* \*baz\*
+.
+<h1>foo <em>bar</em> *baz*</h1>
+ +
+

Leading and trailing [whitespace] is ignored in parsing inline content:

+
+
#                  foo                     
+.
+<h1>foo</h1>
+ +
+

One to three spaces indentation are allowed:

+
+
 ### foo
+  ## foo
+   # foo
+.
+<h3>foo</h3>
+<h2>foo</h2>
+<h1>foo</h1>
+ +
+

Four spaces are too much:

+
+
    # foo
+.
+<pre><code># foo
+</code></pre>
+ +
+
+
foo
+    # bar
+.
+<p>foo
+# bar</p>
+ +
+

A closing sequence of # characters is optional:

+
+
## foo ##
+  ###   bar    ###
+.
+<h2>foo</h2>
+<h3>bar</h3>
+ +
+

It need not be the same length as the opening sequence:

+
+
# foo ##################################
+##### foo ##
+.
+<h1>foo</h1>
+<h5>foo</h5>
+ +
+

Spaces are allowed after the closing sequence:

+
+
### foo ###     
+.
+<h3>foo</h3>
+ +
+

A sequence of # characters with anything but [spaces] following it +is not a closing sequence, but counts as part of the contents of the +heading:

+
+
### foo ### b
+.
+<h3>foo ### b</h3>
+ +
+

The closing sequence must be preceded by a space:

+
+
# foo#
+.
+<h1>foo#</h1>
+ +
+

Backslash-escaped # characters do not count as part +of the closing sequence:

+
+
### foo \###
+## foo #\##
+# foo \#
+.
+<h3>foo ###</h3>
+<h2>foo ###</h2>
+<h1>foo #</h1>
+ +
+

ATX headings need not be separated from surrounding content by blank +lines, and they can interrupt paragraphs:

+
+
****
+## foo
+****
+.
+<hr />
+<h2>foo</h2>
+<hr />
+ +
+
+
Foo bar
+# baz
+Bar foo
+.
+<p>Foo bar</p>
+<h1>baz</h1>
+<p>Bar foo</p>
+ +
+

ATX headings can be empty:

+
+
## 
+#
+### ###
+.
+<h2></h2>
+<h1></h1>
+<h3></h3>
+ +
+

+Setext headings

+

A setext heading consists of one or more +lines of text, each containing at least one [non-whitespace +character], with no more than 3 spaces indentation, followed by +a [setext heading underline]. The lines of text must be such +that, were they not followed by the setext heading underline, +they would be interpreted as a paragraph: they cannot be +interpretable as a [code fence], [ATX heading][ATX headings], +[block quote][block quotes], [thematic break][thematic breaks], +[list item][list items], or [HTML block][HTML blocks].

+

A setext heading underline is a sequence of += characters or a sequence of - characters, with no more than 3 +spaces indentation and any number of trailing spaces. If a line +containing a single - can be interpreted as an +empty [list items], it should be interpreted this way +and not as a [setext heading underline].

+

The heading is a level 1 heading if = characters are used in +the [setext heading underline], and a level 2 heading if - +characters are used. The contents of the heading are the result +of parsing the preceding lines of text as CommonMark inline +content.

+

In general, a setext heading need not be preceded or followed by a +blank line. However, it cannot interrupt a paragraph, so when a +setext heading comes after a paragraph, a blank line is needed between +them.

+

Simple examples:

+
+
Foo *bar*
+=========
+
+Foo *bar*
+---------
+.
+<h1>Foo <em>bar</em></h1>
+<h2>Foo <em>bar</em></h2>
+ +
+

The content of the header may span more than one line:

+
+
Foo *bar
+baz*
+====
+.
+<h1>Foo <em>bar
+baz</em></h1>
+ +
+

The contents are the result of parsing the headings's raw +content as inlines. The heading's raw content is formed by +concatenating the lines and removing initial and final +[whitespace].

+
+
  Foo *bar
+baz*→
+====
+.
+<h1>Foo <em>bar
+baz</em></h1>
+ +
+

The underlining can be any length:

+
+
Foo
+-------------------------
+
+Foo
+=
+.
+<h2>Foo</h2>
+<h1>Foo</h1>
+ +
+

The heading content can be indented up to three spaces, and need +not line up with the underlining:

+
+
   Foo
+---
+
+  Foo
+-----
+
+  Foo
+  ===
+.
+<h2>Foo</h2>
+<h2>Foo</h2>
+<h1>Foo</h1>
+ +
+

Four spaces indent is too much:

+
+
    Foo
+    ---
+
+    Foo
+---
+.
+<pre><code>Foo
+---
+
+Foo
+</code></pre>
+<hr />
+ +
+

The setext heading underline can be indented up to three spaces, and +may have trailing spaces:

+
+
Foo
+   ----      
+.
+<h2>Foo</h2>
+ +
+

Four spaces is too much:

+
+
Foo
+    ---
+.
+<p>Foo
+---</p>
+ +
+

The setext heading underline cannot contain internal spaces:

+
+
Foo
+= =
+
+Foo
+--- -
+.
+<p>Foo
+= =</p>
+<p>Foo</p>
+<hr />
+ +
+

Trailing spaces in the content line do not cause a line break:

+
+
Foo  
+-----
+.
+<h2>Foo</h2>
+ +
+

Nor does a backslash at the end:

+
+
Foo\
+----
+.
+<h2>Foo\</h2>
+ +
+

Since indicators of block structure take precedence over +indicators of inline structure, the following are setext headings:

+
+
`Foo
+----
+`
+
+<a title="a lot
+---
+of dashes"/>
+.
+<h2>`Foo</h2>
+<p>`</p>
+<h2>&lt;a title=&quot;a lot</h2>
+<p>of dashes&quot;/&gt;</p>
+ +
+

The setext heading underline cannot be a [lazy continuation +line] in a list item or block quote:

+
+
> Foo
+---
+.
+<blockquote>
+<p>Foo</p>
+</blockquote>
+<hr />
+ +
+
+
> foo
+bar
+===
+.
+<blockquote>
+<p>foo
+bar
+===</p>
+</blockquote>
+ +
+
+
- Foo
+---
+.
+<ul>
+<li>Foo</li>
+</ul>
+<hr />
+ +
+

A blank line is needed between a paragraph and a following +setext heading, since otherwise the paragraph becomes part +of the heading's content:

+
+
Foo
+Bar
+---
+.
+<h2>Foo
+Bar</h2>
+ +
+

But in general a blank line is not required before or after +setext headings:

+
+
---
+Foo
+---
+Bar
+---
+Baz
+.
+<hr />
+<h2>Foo</h2>
+<h2>Bar</h2>
+<p>Baz</p>
+ +
+

Setext headings cannot be empty:

+
+

+====
+.
+<p>====</p>
+ +
+

Setext heading text lines must not be interpretable as block +constructs other than paragraphs. So, the line of dashes +in these examples gets interpreted as a thematic break:

+
+
---
+---
+.
+<hr />
+<hr />
+ +
+
+
- foo
+-----
+.
+<ul>
+<li>foo</li>
+</ul>
+<hr />
+ +
+
+
    foo
+---
+.
+<pre><code>foo
+</code></pre>
+<hr />
+ +
+
+
> foo
+-----
+.
+<blockquote>
+<p>foo</p>
+</blockquote>
+<hr />
+ +
+

If you want a heading with > foo as its literal text, you can +use backslash escapes:

+
+
\> foo
+------
+.
+<h2>&gt; foo</h2>
+ +
+

Compatibility note: Most existing Markdown implementations +do not allow the text of setext headings to span multiple lines. +But there is no consensus about how to interpret

+
+
Foo
+bar
+---
+baz
+ +
+

One can find four different interpretations:

+
    +
  1. paragraph "Foo", heading "bar", paragraph "baz"
    2. +
  2. paragraph "Foo bar", thematic break, paragraph "baz"
    3. +
  3. paragraph "Foo bar --- baz"
    4. +
  4. heading "Foo bar", paragraph "baz"
    5. +
+

We find interpretation 4 most natural, and interpretation 4 +increases the expressive power of CommonMark, by allowing +multiline headings. Authors who want interpretation 1 can +put a blank line after the first paragraph:

+
+
Foo
+
+bar
+---
+baz
+.
+<p>Foo</p>
+<h2>bar</h2>
+<p>baz</p>
+ +
+

Authors who want interpretation 2 can put blank lines around +the thematic break,

+
+
Foo
+bar
+
+---
+
+baz
+.
+<p>Foo
+bar</p>
+<hr />
+<p>baz</p>
+ +
+

or use a thematic break that cannot count as a [setext heading +underline], such as

+
+
Foo
+bar
+* * *
+baz
+.
+<p>Foo
+bar</p>
+<hr />
+<p>baz</p>
+ +
+

Authors who want interpretation 3 can use backslash escapes:

+
+
Foo
+bar
+\---
+baz
+.
+<p>Foo
+bar
+---
+baz</p>
+ +
+

+Indented code blocks

+

An indented code block is composed of one or more +[indented chunks] separated by blank lines. +An indented chunk is a sequence of non-blank lines, +each indented four or more spaces. The contents of the code block are +the literal contents of the lines, including trailing +[line endings], minus four spaces of indentation. +An indented code block has no [info string].

+

An indented code block cannot interrupt a paragraph, so there must be +a blank line between a paragraph and a following indented code block. +(A blank line is not needed, however, between a code block and a following +paragraph.)

+
+
    a simple
+      indented code block
+.
+<pre><code>a simple
+  indented code block
+</code></pre>
+ +
+

If there is any ambiguity between an interpretation of indentation +as a code block and as indicating that material belongs to a [list +item][list items], the list item interpretation takes precedence:

+
+
  - foo
+
+    bar
+.
+<ul>
+<li>
+<p>foo</p>
+<p>bar</p>
+</li>
+</ul>
+ +
+
+
1.  foo
+
+    - bar
+.
+<ol>
+<li>
+<p>foo</p>
+<ul>
+<li>bar</li>
+</ul>
+</li>
+</ol>
+ +
+

The contents of a code block are literal text, and do not get parsed +as Markdown:

+
+
    <a/>
+    *hi*
+
+    - one
+.
+<pre><code>&lt;a/&gt;
+*hi*
+
+- one
+</code></pre>
+ +
+

Here we have three chunks separated by blank lines:

+
+
    chunk1
+
+    chunk2
+  
+ 
+ 
+    chunk3
+.
+<pre><code>chunk1
+
+chunk2
+
+
+
+chunk3
+</code></pre>
+ +
+

Any initial spaces beyond four will be included in the content, even +in interior blank lines:

+
+
    chunk1
+      
+      chunk2
+.
+<pre><code>chunk1
+  
+  chunk2
+</code></pre>
+ +
+

An indented code block cannot interrupt a paragraph. (This +allows hanging indents and the like.)

+
+
Foo
+    bar
+
+.
+<p>Foo
+bar</p>
+ +
+

However, any non-blank line with fewer than four leading spaces ends +the code block immediately. So a paragraph may occur immediately +after indented code:

+
+
    foo
+bar
+.
+<pre><code>foo
+</code></pre>
+<p>bar</p>
+ +
+

And indented code can occur immediately before and after other kinds of +blocks:

+
+
# Heading
+    foo
+Heading
+------
+    foo
+----
+.
+<h1>Heading</h1>
+<pre><code>foo
+</code></pre>
+<h2>Heading</h2>
+<pre><code>foo
+</code></pre>
+<hr />
+ +
+

The first line can be indented more than four spaces:

+
+
        foo
+    bar
+.
+<pre><code>    foo
+bar
+</code></pre>
+ +
+

Blank lines preceding or following an indented code block +are not included in it:

+
+

+    
+    foo
+    
+
+.
+<pre><code>foo
+</code></pre>
+ +
+

Trailing spaces are included in the code block's content:

+
+
    foo  
+.
+<pre><code>foo  
+</code></pre>
+ +
+

+Fenced code blocks

+

A code fence is a sequence +of at least three consecutive backtick characters (`) or +tildes (~). (Tildes and backticks cannot be mixed.) +A fenced code block +begins with a code fence, indented no more than three spaces.

+

The line with the opening code fence may optionally contain some text +following the code fence; this is trimmed of leading and trailing +whitespace and called the info string. If the [info string] comes +after a backtick fence, it may not contain any backtick +characters. (The reason for this restriction is that otherwise +some inline code would be incorrectly interpreted as the +beginning of a fenced code block.)

+

The content of the code block consists of all subsequent lines, until +a closing [code fence] of the same type as the code block +began with (backticks or tildes), and with at least as many backticks +or tildes as the opening code fence. If the leading code fence is +indented N spaces, then up to N spaces of indentation are removed from +each line of the content (if present). (If a content line is not +indented, it is preserved unchanged. If it is indented less than N +spaces, all of the indentation is removed.)

+

The closing code fence may be indented up to three spaces, and may be +followed only by spaces, which are ignored. If the end of the +containing block (or document) is reached and no closing code fence +has been found, the code block contains all of the lines after the +opening code fence until the end of the containing block (or +document). (An alternative spec would require backtracking in the +event that a closing code fence is not found. But this makes parsing +much less efficient, and there seems to be no real down side to the +behavior described here.)

+

A fenced code block may interrupt a paragraph, and does not require +a blank line either before or after.

+

The content of a code fence is treated as literal text, not parsed +as inlines. The first word of the [info string] is typically used to +specify the language of the code sample, and rendered in the class +attribute of the code tag. However, this spec does not mandate any +particular treatment of the [info string].

+

Here is a simple example with backticks:

+
+
```
+<
+ >
+```
+.
+<pre><code>&lt;
+ &gt;
+</code></pre>
+ +
+

With tildes:

+
+
~~~
+<
+ >
+~~~
+.
+<pre><code>&lt;
+ &gt;
+</code></pre>
+ +
+

Fewer than three backticks is not enough:

+
+
``
+foo
+``
+.
+<p><code>foo</code></p>
+ +
+

The closing code fence must use the same character as the opening +fence:

+
+
```
+aaa
+~~~
+```
+.
+<pre><code>aaa
+~~~
+</code></pre>
+ +
+
+
~~~
+aaa
+```
+~~~
+.
+<pre><code>aaa
+```
+</code></pre>
+ +
+

The closing code fence must be at least as long as the opening fence:

+
+
````
+aaa
+```
+``````
+.
+<pre><code>aaa
+```
+</code></pre>
+ +
+
+
~~~~
+aaa
+~~~
+~~~~
+.
+<pre><code>aaa
+~~~
+</code></pre>
+ +
+

Unclosed code blocks are closed by the end of the document +(or the enclosing [block quote][block quotes] or [list item][list items]):

+
+
```
+.
+<pre><code></code></pre>
+ +
+
+
`````
+
+```
+aaa
+.
+<pre><code>
+```
+aaa
+</code></pre>
+ +
+
+
> ```
+> aaa
+
+bbb
+.
+<blockquote>
+<pre><code>aaa
+</code></pre>
+</blockquote>
+<p>bbb</p>
+ +
+

A code block can have all empty lines as its content:

+
+
```
+
+  
+```
+.
+<pre><code>
+  
+</code></pre>
+ +
+

A code block can be empty:

+
+
```
+```
+.
+<pre><code></code></pre>
+ +
+

Fences can be indented. If the opening fence is indented, +content lines will have equivalent opening indentation removed, +if present:

+
+
 ```
+ aaa
+aaa
+```
+.
+<pre><code>aaa
+aaa
+</code></pre>
+ +
+
+
  ```
+aaa
+  aaa
+aaa
+  ```
+.
+<pre><code>aaa
+aaa
+aaa
+</code></pre>
+ +
+
+
   ```
+   aaa
+    aaa
+  aaa
+   ```
+.
+<pre><code>aaa
+ aaa
+aaa
+</code></pre>
+ +
+

Four spaces indentation produces an indented code block:

+
+
    ```
+    aaa
+    ```
+.
+<pre><code>```
+aaa
+```
+</code></pre>
+ +
+

Closing fences may be indented by 0-3 spaces, and their indentation +need not match that of the opening fence:

+
+
```
+aaa
+  ```
+.
+<pre><code>aaa
+</code></pre>
+ +
+
+
   ```
+aaa
+  ```
+.
+<pre><code>aaa
+</code></pre>
+ +
+

This is not a closing fence, because it is indented 4 spaces:

+
+
```
+aaa
+    ```
+.
+<pre><code>aaa
+    ```
+</code></pre>
+ +
+

Code fences (opening and closing) cannot contain internal spaces:

+
+
``` ```
+aaa
+.
+<p><code> </code>
+aaa</p>
+ +
+
+
~~~~~~
+aaa
+~~~ ~~
+.
+<pre><code>aaa
+~~~ ~~
+</code></pre>
+ +
+

Fenced code blocks can interrupt paragraphs, and can be followed +directly by paragraphs, without a blank line between:

+
+
foo
+```
+bar
+```
+baz
+.
+<p>foo</p>
+<pre><code>bar
+</code></pre>
+<p>baz</p>
+ +
+

Other blocks can also occur before and after fenced code blocks +without an intervening blank line:

+
+
foo
+---
+~~~
+bar
+~~~
+# baz
+.
+<h2>foo</h2>
+<pre><code>bar
+</code></pre>
+<h1>baz</h1>
+ +
+

An [info string] can be provided after the opening code fence. +Although this spec doesn't mandate any particular treatment of +the info string, the first word is typically used to specify +the language of the code block. In HTML output, the language is +normally indicated by adding a class to the code element consisting +of language- followed by the language name.

+
+
```ruby
+def foo(x)
+  return 3
+end
+```
+.
+<pre><code class="language-ruby">def foo(x)
+  return 3
+end
+</code></pre>
+ +
+
+
~~~~    ruby startline=3 $%@#$
+def foo(x)
+  return 3
+end
+~~~~~~~
+.
+<pre><code class="language-ruby">def foo(x)
+  return 3
+end
+</code></pre>
+ +
+
+
````;
+````
+.
+<pre><code class="language-;"></code></pre>
+ +
+

[Info strings] for backtick code blocks cannot contain backticks:

+
+
``` aa ```
+foo
+.
+<p><code>aa</code>
+foo</p>
+ +
+

[Info strings] for tilde code blocks can contain backticks and tildes:

+
+
~~~ aa ``` ~~~
+foo
+~~~
+.
+<pre><code class="language-aa">foo
+</code></pre>
+ +
+

Closing code fences cannot have [info strings]:

+
+
```
+``` aaa
+```
+.
+<pre><code>``` aaa
+</code></pre>
+ +
+

+HTML blocks

+

An HTML block is a group of lines that is treated +as raw HTML (and will not be escaped in HTML output).

+

There are seven kinds of [HTML block], which can be defined by their +start and end conditions. The block begins with a line that meets a +start condition (after up to three spaces optional indentation). +It ends with the first subsequent line that meets a matching end +condition, or the last line of the document, or the last line of +the container block containing the current HTML +block, if no line is encountered that meets the [end condition]. If +the first line meets both the [start condition] and the [end +condition], the block will contain just that line.

+
    +
  1. +

    Start condition: line begins with the string <script, +<pre, or <style (case-insensitive), followed by whitespace, +the string >, or the end of the line.
    +End condition: line contains an end tag +</script>, </pre>, or </style> (case-insensitive; it +need not match the start tag).

    +
    2. +
  2. +

    Start condition: line begins with the string <!--.
    +End condition: line contains the string -->.

    +
    3. +
  3. +

    Start condition: line begins with the string <?.
    +End condition: line contains the string ?>.

    +
    4. +
  4. +

    Start condition: line begins with the string <! +followed by an uppercase ASCII letter.
    +End condition: line contains the character >.

    +
    5. +
  5. +

    Start condition: line begins with the string +<![CDATA[.
    +End condition: line contains the string ]]>.

    +
    6. +
  6. +

    Start condition: line begins the string < or </ +followed by one of the strings (case-insensitive) address, +article, aside, base, basefont, blockquote, body, +caption, center, col, colgroup, dd, details, dialog, +dir, div, dl, dt, fieldset, figcaption, figure, +footer, form, frame, frameset, +h1, h2, h3, h4, h5, h6, head, header, hr, +html, iframe, legend, li, link, main, menu, menuitem, +nav, noframes, ol, optgroup, option, p, param, +section, summary, table, tbody, td, +tfoot, th, thead, title, tr, track, ul, followed +by [whitespace], the end of the line, the string >, or +the string />.
    +End condition: line is followed by a [blank line].

    +
    7. +
  7. +

    Start condition: line begins with a complete [open tag] +(with any [tag name] other than script, +style, or pre) or a complete [closing tag], +followed only by [whitespace] or the end of the line.
    +End condition: line is followed by a [blank line].

    +
    8. +
+

HTML blocks continue until they are closed by their appropriate +[end condition], or the last line of the document or other container +block. This means any HTML within an HTML +block that might otherwise be recognised as a start condition will +be ignored by the parser and passed through as-is, without changing +the parser's state.

+

For instance, <pre> within a HTML block started by <table> will not affect +the parser state; as the HTML block was started in by start condition 6, it +will end at any blank line. This can be surprising:

+
+
<table><tr><td>
+<pre>
+**Hello**,
+
+_world_.
+</pre>
+</td></tr></table>
+.
+<table><tr><td>
+<pre>
+**Hello**,
+<p><em>world</em>.
+</pre></p>
+</td></tr></table>
+ +
+

In this case, the HTML block is terminated by the newline — the **Hello** +text remains verbatim — and regular parsing resumes, with a paragraph, +emphasised world and inline and block HTML following.

+

All types of [HTML blocks] except type 7 may interrupt +a paragraph. Blocks of type 7 may not interrupt a paragraph. +(This restriction is intended to prevent unwanted interpretation +of long tags inside a wrapped paragraph as starting HTML blocks.)

+

Some simple examples follow. Here are some basic HTML blocks +of type 6:

+
+
<table>
+  <tr>
+    <td>
+           hi
+    </td>
+  </tr>
+</table>
+
+okay.
+.
+<table>
+  <tr>
+    <td>
+           hi
+    </td>
+  </tr>
+</table>
+<p>okay.</p>
+ +
+
+
 <div>
+  *hello*
+         <foo><a>
+.
+ <div>
+  *hello*
+         <foo><a>
+ +
+

A block can also start with a closing tag:

+
+
</div>
+*foo*
+.
+</div>
+*foo*
+ +
+

Here we have two HTML blocks with a Markdown paragraph between them:

+
+
<DIV CLASS="foo">
+
+*Markdown*
+
+</DIV>
+.
+<DIV CLASS="foo">
+<p><em>Markdown</em></p>
+</DIV>
+ +
+

The tag on the first line can be partial, as long +as it is split where there would be whitespace:

+
+
<div id="foo"
+  class="bar">
+</div>
+.
+<div id="foo"
+  class="bar">
+</div>
+ +
+
+
<div id="foo" class="bar
+  baz">
+</div>
+.
+<div id="foo" class="bar
+  baz">
+</div>
+ +
+

An open tag need not be closed:

+
+
<div>
+*foo*
+
+*bar*
+.
+<div>
+*foo*
+<p><em>bar</em></p>
+ +
+

A partial tag need not even be completed (garbage +in, garbage out):

+
+
<div id="foo"
+*hi*
+.
+<div id="foo"
+*hi*
+ +
+
+
<div class
+foo
+.
+<div class
+foo
+ +
+

The initial tag doesn't even need to be a valid +tag, as long as it starts like one:

+
+
<div *???-&&&-<---
+*foo*
+.
+<div *???-&&&-<---
+*foo*
+ +
+

In type 6 blocks, the initial tag need not be on a line by +itself:

+
+
<div><a href="bar">*foo*</a></div>
+.
+<div><a href="bar">*foo*</a></div>
+ +
+
+
<table><tr><td>
+foo
+</td></tr></table>
+.
+<table><tr><td>
+foo
+</td></tr></table>
+ +
+

Everything until the next blank line or end of document +gets included in the HTML block. So, in the following +example, what looks like a Markdown code block +is actually part of the HTML block, which continues until a blank +line or the end of the document is reached:

+
+
<div></div>
+``` c
+int x = 33;
+```
+.
+<div></div>
+``` c
+int x = 33;
+```
+ +
+

To start an [HTML block] with a tag that is not in the +list of block-level tags in (6), you must put the tag by +itself on the first line (and it must be complete):

+
+
<a href="foo">
+*bar*
+</a>
+.
+<a href="foo">
+*bar*
+</a>
+ +
+

In type 7 blocks, the [tag name] can be anything:

+
+
<Warning>
+*bar*
+</Warning>
+.
+<Warning>
+*bar*
+</Warning>
+ +
+
+
<i class="foo">
+*bar*
+</i>
+.
+<i class="foo">
+*bar*
+</i>
+ +
+
+
</ins>
+*bar*
+.
+</ins>
+*bar*
+ +
+

These rules are designed to allow us to work with tags that +can function as either block-level or inline-level tags. +The <del> tag is a nice example. We can surround content with +<del> tags in three different ways. In this case, we get a raw +HTML block, because the <del> tag is on a line by itself:

+
+
<del>
+*foo*
+</del>
+.
+<del>
+*foo*
+</del>
+ +
+

In this case, we get a raw HTML block that just includes +the <del> tag (because it ends with the following blank +line). So the contents get interpreted as CommonMark:

+
+
<del>
+
+*foo*
+
+</del>
+.
+<del>
+<p><em>foo</em></p>
+</del>
+ +
+

Finally, in this case, the <del> tags are interpreted +as [raw HTML] inside the CommonMark paragraph. (Because +the tag is not on a line by itself, we get inline HTML +rather than an [HTML block].)

+
+
<del>*foo*</del>
+.
+<p><del><em>foo</em></del></p>
+ +
+

HTML tags designed to contain literal content +(script, style, pre), comments, processing instructions, +and declarations are treated somewhat differently. +Instead of ending at the first blank line, these blocks +end at the first line containing a corresponding end tag. +As a result, these blocks can contain blank lines:

+

A pre tag (type 1):

+
+
<pre language="haskell"><code>
+import Text.HTML.TagSoup
+
+main :: IO ()
+main = print $ parseTags tags
+</code></pre>
+okay
+.
+<pre language="haskell"><code>
+import Text.HTML.TagSoup
+
+main :: IO ()
+main = print $ parseTags tags
+</code></pre>
+<p>okay</p>
+ +
+

A script tag (type 1):

+
+
<script type="text/javascript">
+// JavaScript example
+
+document.getElementById("demo").innerHTML = "Hello JavaScript!";
+</script>
+okay
+.
+<script type="text/javascript">
+// JavaScript example
+
+document.getElementById("demo").innerHTML = "Hello JavaScript!";
+</script>
+<p>okay</p>
+ +
+

A style tag (type 1):

+
+
<style
+  type="text/css">
+h1 {color:red;}
+
+p {color:blue;}
+</style>
+okay
+.
+<style
+  type="text/css">
+h1 {color:red;}
+
+p {color:blue;}
+</style>
+<p>okay</p>
+ +
+

If there is no matching end tag, the block will end at the +end of the document (or the enclosing [block quote][block quotes] +or [list item][list items]):

+
+
<style
+  type="text/css">
+
+foo
+.
+<style
+  type="text/css">
+
+foo
+ +
+
+
> <div>
+> foo
+
+bar
+.
+<blockquote>
+<div>
+foo
+</blockquote>
+<p>bar</p>
+ +
+
+
- <div>
+- foo
+.
+<ul>
+<li>
+<div>
+</li>
+<li>foo</li>
+</ul>
+ +
+

The end tag can occur on the same line as the start tag:

+
+
<style>p{color:red;}</style>
+*foo*
+.
+<style>p{color:red;}</style>
+<p><em>foo</em></p>
+ +
+
+
<!-- foo -->*bar*
+*baz*
+.
+<!-- foo -->*bar*
+<p><em>baz</em></p>
+ +
+

Note that anything on the last line after the +end tag will be included in the [HTML block]:

+
+
<script>
+foo
+</script>1. *bar*
+.
+<script>
+foo
+</script>1. *bar*
+ +
+

A comment (type 2):

+
+
<!-- Foo
+
+bar
+   baz -->
+okay
+.
+<!-- Foo
+
+bar
+   baz -->
+<p>okay</p>
+ +
+

A processing instruction (type 3):

+
+
<?php
+
+  echo '>';
+
+?>
+okay
+.
+<?php
+
+  echo '>';
+
+?>
+<p>okay</p>
+ +
+

A declaration (type 4):

+
+
<!DOCTYPE html>
+.
+<!DOCTYPE html>
+ +
+

CDATA (type 5):

+
+
<![CDATA[
+function matchwo(a,b)
+{
+  if (a < b && a < 0) then {
+    return 1;
+
+  } else {
+
+    return 0;
+  }
+}
+]]>
+okay
+.
+<![CDATA[
+function matchwo(a,b)
+{
+  if (a < b && a < 0) then {
+    return 1;
+
+  } else {
+
+    return 0;
+  }
+}
+]]>
+<p>okay</p>
+ +
+

The opening tag can be indented 1-3 spaces, but not 4:

+
+
  <!-- foo -->
+
+    <!-- foo -->
+.
+  <!-- foo -->
+<pre><code>&lt;!-- foo --&gt;
+</code></pre>
+ +
+
+
  <div>
+
+    <div>
+.
+  <div>
+<pre><code>&lt;div&gt;
+</code></pre>
+ +
+

An HTML block of types 1--6 can interrupt a paragraph, and need not be +preceded by a blank line.

+
+
Foo
+<div>
+bar
+</div>
+.
+<p>Foo</p>
+<div>
+bar
+</div>
+ +
+

However, a following blank line is needed, except at the end of +a document, and except for blocks of types 1--5, [above][HTML +block]:

+
+
<div>
+bar
+</div>
+*foo*
+.
+<div>
+bar
+</div>
+*foo*
+ +
+

HTML blocks of type 7 cannot interrupt a paragraph:

+
+
Foo
+<a href="bar">
+baz
+.
+<p>Foo
+<a href="bar">
+baz</p>
+ +
+

This rule differs from John Gruber's original Markdown syntax +specification, which says:

+
+

The only restrictions are that block-level HTML elements — +e.g. <div>, <table>, <pre>, <p>, etc. — must be separated from +surrounding content by blank lines, and the start and end tags of the +block should not be indented with tabs or spaces.

+
+

In some ways Gruber's rule is more restrictive than the one given +here:

+ +

Most Markdown implementations (including some of Gruber's own) do not +respect all of these restrictions.

+

There is one respect, however, in which Gruber's rule is more liberal +than the one given here, since it allows blank lines to occur inside +an HTML block. There are two reasons for disallowing them here. +First, it removes the need to parse balanced tags, which is +expensive and can require backtracking from the end of the document +if no matching end tag is found. Second, it provides a very simple +and flexible way of including Markdown content inside HTML tags: +simply separate the Markdown from the HTML using blank lines:

+

Compare:

+
+
<div>
+
+*Emphasized* text.
+
+</div>
+.
+<div>
+<p><em>Emphasized</em> text.</p>
+</div>
+ +
+
+
<div>
+*Emphasized* text.
+</div>
+.
+<div>
+*Emphasized* text.
+</div>
+ +
+

Some Markdown implementations have adopted a convention of +interpreting content inside tags as text if the open tag has +the attribute markdown=1. The rule given above seems a simpler and +more elegant way of achieving the same expressive power, which is also +much simpler to parse.

+

The main potential drawback is that one can no longer paste HTML +blocks into Markdown documents with 100% reliability. However, +in most cases this will work fine, because the blank lines in +HTML are usually followed by HTML block tags. For example:

+
+
<table>
+
+<tr>
+
+<td>
+Hi
+</td>
+
+</tr>
+
+</table>
+.
+<table>
+<tr>
+<td>
+Hi
+</td>
+</tr>
+</table>
+ +
+

There are problems, however, if the inner tags are indented +and separated by spaces, as then they will be interpreted as +an indented code block:

+
+
<table>
+
+  <tr>
+
+    <td>
+      Hi
+    </td>
+
+  </tr>
+
+</table>
+.
+<table>
+  <tr>
+<pre><code>&lt;td&gt;
+  Hi
+&lt;/td&gt;
+</code></pre>
+  </tr>
+</table>
+ +
+

Fortunately, blank lines are usually not necessary and can be +deleted. The exception is inside <pre> tags, but as described +[above][HTML blocks], raw HTML blocks starting with <pre> +can contain blank lines.

+

+Link reference definitions

+

A link reference definition +consists of a [link label], indented up to three spaces, followed +by a colon (:), optional [whitespace] (including up to one +[line ending]), a [link destination], +optional [whitespace] (including up to one +[line ending]), and an optional [link +title], which if it is present must be separated +from the [link destination] by [whitespace]. +No further [non-whitespace characters] may occur on the line.

+

A [link reference definition] +does not correspond to a structural element of a document. Instead, it +defines a label which can be used in [reference links] +and reference-style [images] elsewhere in the document. [Link +reference definitions] can come either before or after the links that use +them.

+
+
[foo]: /url "title"
+
+[foo]
+.
+<p><a href="/url" title="title">foo</a></p>
+ +
+
+
   [foo]: 
+      /url  
+           'the title'  
+
+[foo]
+.
+<p><a href="/url" title="the title">foo</a></p>
+ +
+
+
[Foo*bar\]]:my_(url) 'title (with parens)'
+
+[Foo*bar\]]
+.
+<p><a href="my_(url)" title="title (with parens)">Foo*bar]</a></p>
+ +
+
+
[Foo bar]:
+<my url>
+'title'
+
+[Foo bar]
+.
+<p><a href="my%20url" title="title">Foo bar</a></p>
+ +
+

The title may extend over multiple lines:

+
+
[foo]: /url '
+title
+line1
+line2
+'
+
+[foo]
+.
+<p><a href="/url" title="
+title
+line1
+line2
+">foo</a></p>
+ +
+

However, it may not contain a [blank line]:

+
+
[foo]: /url 'title
+
+with blank line'
+
+[foo]
+.
+<p>[foo]: /url 'title</p>
+<p>with blank line'</p>
+<p>[foo]</p>
+ +
+

The title may be omitted:

+
+
[foo]:
+/url
+
+[foo]
+.
+<p><a href="/url">foo</a></p>
+ +
+

The link destination may not be omitted:

+
+
[foo]:
+
+[foo]
+.
+<p>[foo]:</p>
+<p>[foo]</p>
+ +
+

However, an empty link destination may be specified using +angle brackets:

+
+
[foo]: <>
+
+[foo]
+.
+<p><a href="">foo</a></p>
+ +
+

The title must be separated from the link destination by +whitespace:

+
+
[foo]: <bar>(baz)
+
+[foo]
+.
+<p>[foo]: <bar>(baz)</p>
+<p>[foo]</p>
+ +
+

Both title and destination can contain backslash escapes +and literal backslashes:

+
+
[foo]: /url\bar\*baz "foo\"bar\baz"
+
+[foo]
+.
+<p><a href="/url%5Cbar*baz" title="foo&quot;bar\baz">foo</a></p>
+ +
+

A link can come before its corresponding definition:

+
+
[foo]
+
+[foo]: url
+.
+<p><a href="url">foo</a></p>
+ +
+

If there are several matching definitions, the first one takes +precedence:

+
+
[foo]
+
+[foo]: first
+[foo]: second
+.
+<p><a href="first">foo</a></p>
+ +
+

As noted in the section on [Links], matching of labels is +case-insensitive (see [matches]).

+
+
[FOO]: /url
+
+[Foo]
+.
+<p><a href="/url">Foo</a></p>
+ +
+
+
[ΑΓΩ]: /Ï†ÎżÏ…
+
+[Î±ÎłÏ‰]
+.
+<p><a href="/%CF%86%CE%BF%CF%85">Î±ÎłÏ‰</a></p>
+ +
+

Here is a link reference definition with no corresponding link. +It contributes nothing to the document.

+
+
[foo]: /url
+.
+ +
+

Here is another one:

+
+
[
+foo
+]: /url
+bar
+.
+<p>bar</p>
+ +
+

This is not a link reference definition, because there are +[non-whitespace characters] after the title:

+
+
[foo]: /url "title" ok
+.
+<p>[foo]: /url &quot;title&quot; ok</p>
+ +
+

This is a link reference definition, but it has no title:

+
+
[foo]: /url
+"title" ok
+.
+<p>&quot;title&quot; ok</p>
+ +
+

This is not a link reference definition, because it is indented +four spaces:

+
+
    [foo]: /url "title"
+
+[foo]
+.
+<pre><code>[foo]: /url &quot;title&quot;
+</code></pre>
+<p>[foo]</p>
+ +
+

This is not a link reference definition, because it occurs inside +a code block:

+
+
```
+[foo]: /url
+```
+
+[foo]
+.
+<pre><code>[foo]: /url
+</code></pre>
+<p>[foo]</p>
+ +
+

A [link reference definition] cannot interrupt a paragraph.

+
+
Foo
+[bar]: /baz
+
+[bar]
+.
+<p>Foo
+[bar]: /baz</p>
+<p>[bar]</p>
+ +
+

However, it can directly follow other block elements, such as headings +and thematic breaks, and it need not be followed by a blank line.

+
+
# [Foo]
+[foo]: /url
+> bar
+.
+<h1><a href="/url">Foo</a></h1>
+<blockquote>
+<p>bar</p>
+</blockquote>
+ +
+
+
[foo]: /url
+bar
+===
+[foo]
+.
+<h1>bar</h1>
+<p><a href="/url">foo</a></p>
+ +
+
+
[foo]: /url
+===
+[foo]
+.
+<p>===
+<a href="/url">foo</a></p>
+ +
+

Several [link reference definitions] +can occur one after another, without intervening blank lines.

+
+
[foo]: /foo-url "foo"
+[bar]: /bar-url
+  "bar"
+[baz]: /baz-url
+
+[foo],
+[bar],
+[baz]
+.
+<p><a href="/foo-url" title="foo">foo</a>,
+<a href="/bar-url" title="bar">bar</a>,
+<a href="/baz-url">baz</a></p>
+ +
+

[Link reference definitions] can occur +inside block containers, like lists and block quotations. They +affect the entire document, not just the container in which they +are defined:

+
+
[foo]
+
+> [foo]: /url
+.
+<p><a href="/url">foo</a></p>
+<blockquote>
+</blockquote>
+ +
+

Whether something is a [link reference definition] is +independent of whether the link reference it defines is +used in the document. Thus, for example, the following +document contains just a link reference definition, and +no visible content:

+
+
[foo]: /url
+.
+ +
+

+Paragraphs

+

A sequence of non-blank lines that cannot be interpreted as other +kinds of blocks forms a paragraph. +The contents of the paragraph are the result of parsing the +paragraph's raw content as inlines. The paragraph's raw content +is formed by concatenating the lines and removing initial and final +[whitespace].

+

A simple example with two paragraphs:

+
+
aaa
+
+bbb
+.
+<p>aaa</p>
+<p>bbb</p>
+ +
+

Paragraphs can contain multiple lines, but no blank lines:

+
+
aaa
+bbb
+
+ccc
+ddd
+.
+<p>aaa
+bbb</p>
+<p>ccc
+ddd</p>
+ +
+

Multiple blank lines between paragraph have no effect:

+
+
aaa
+
+
+bbb
+.
+<p>aaa</p>
+<p>bbb</p>
+ +
+

Leading spaces are skipped:

+
+
  aaa
+ bbb
+.
+<p>aaa
+bbb</p>
+ +
+

Lines after the first may be indented any amount, since indented +code blocks cannot interrupt paragraphs.

+
+
aaa
+             bbb
+                                       ccc
+.
+<p>aaa
+bbb
+ccc</p>
+ +
+

However, the first line may be indented at most three spaces, +or an indented code block will be triggered:

+
+
   aaa
+bbb
+.
+<p>aaa
+bbb</p>
+ +
+
+
    aaa
+bbb
+.
+<pre><code>aaa
+</code></pre>
+<p>bbb</p>
+ +
+

Final spaces are stripped before inline parsing, so a paragraph +that ends with two or more spaces will not end with a [hard line +break]:

+
+
aaa     
+bbb     
+.
+<p>aaa<br />
+bbb</p>
+ +
+

+Blank lines

+

[Blank lines] between block-level elements are ignored, +except for the role they play in determining whether a [list] +is [tight] or [loose].

+

Blank lines at the beginning and end of the document are also ignored.

+
+
  
+
+aaa
+  
+
+# aaa
+
+  
+.
+<p>aaa</p>
+<h1>aaa</h1>
+ +
+
+

+Tables (extension)

+

GFM enables the table extension, where an additional leaf block type is +available.

+

A table is an arrangement of data with rows and columns, consisting of a +single header row, a [delimiter row] separating the header from the data, and +zero or more data rows.

+

Each row consists of cells containing arbitrary text, in which [inlines] are +parsed, separated by pipes (|). A leading and trailing pipe is also +recommended for clarity of reading, and if there's otherwise parsing ambiguity. +Spaces between pipes and cell content are trimmed. Block-level elements cannot +be inserted in a table.

+

The delimiter row consists of cells whose only content are hyphens (-), +and optionally, a leading or trailing colon (:), or both, to indicate left, +right, or center alignment respectively.

+
+
| foo | bar |
+| --- | --- |
+| baz | bim |
+.
+<table>
+<thead>
+<tr>
+<th>foo</th>
+<th>bar</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>baz</td>
+<td>bim</td>
+</tr>
+</tbody>
+</table>
+ +
+

Cells in one column don't need to match length, though it's easier to read if +they are. Likewise, use of leading and trailing pipes may be inconsistent:

+
+
| abc | defghi |
+:-: | -----------:
+bar | baz
+.
+<table>
+<thead>
+<tr>
+<th align="center">abc</th>
+<th align="right">defghi</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="center">bar</td>
+<td align="right">baz</td>
+</tr>
+</tbody>
+</table>
+ +
+

Include a pipe in a cell's content by escaping it, including inside other +inline spans:

+
+
| f\|oo  |
+| ------ |
+| b `\|` az |
+| b **\|** im |
+.
+<table>
+<thead>
+<tr>
+<th>f|oo</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>b <code>|</code> az</td>
+</tr>
+<tr>
+<td>b <strong>|</strong> im</td>
+</tr>
+</tbody>
+</table>
+ +
+

The table is broken at the first empty line, or beginning of another +block-level structure:

+
+
| abc | def |
+| --- | --- |
+| bar | baz |
+> bar
+.
+<table>
+<thead>
+<tr>
+<th>abc</th>
+<th>def</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>bar</td>
+<td>baz</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<p>bar</p>
+</blockquote>
+ +
+
+
| abc | def |
+| --- | --- |
+| bar | baz |
+bar
+
+bar
+.
+<table>
+<thead>
+<tr>
+<th>abc</th>
+<th>def</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>bar</td>
+<td>baz</td>
+</tr>
+<tr>
+<td>bar</td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<p>bar</p>
+ +
+

The header row must match the [delimiter row] in the number of cells. If not, +a table will not be recognized:

+
+
| abc | def |
+| --- |
+| bar |
+.
+<p>| abc | def |
+| --- |
+| bar |</p>
+ +
+

The remainder of the table's rows may vary in the number of cells. If there +are a number of cells fewer than the number of cells in the header row, empty +cells are inserted. If there are greater, the excess is ignored:

+
+
| abc | def |
+| --- | --- |
+| bar |
+| bar | baz | boo |
+.
+<table>
+<thead>
+<tr>
+<th>abc</th>
+<th>def</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>bar</td>
+<td></td>
+</tr>
+<tr>
+<td>bar</td>
+<td>baz</td>
+</tr>
+</tbody>
+</table>
+ +
+

If there are no rows in the body, no <tbody> is generated in HTML output:

+
+
| abc | def |
+| --- | --- |
+.
+<table>
+<thead>
+<tr>
+<th>abc</th>
+<th>def</th>
+</tr>
+</thead>
+</table>
+ +
+
+

+Container blocks

+

A container block is a block that has other +blocks as its contents. There are two basic kinds of container blocks: +[block quotes] and [list items]. +[Lists] are meta-containers for [list items].

+

We define the syntax for container blocks recursively. The general +form of the definition is:

+
+

If X is a sequence of blocks, then the result of +transforming X in such-and-such a way is a container of type Y +with these blocks as its content.

+
+

So, we explain what counts as a block quote or list item by explaining +how these can be generated from their contents. This should suffice +to define the syntax, although it does not give a recipe for parsing +these constructions. (A recipe is provided below in the section entitled +A parsing strategy.)

+

+Block quotes

+

A block quote marker +consists of 0-3 spaces of initial indent, plus (a) the character > together +with a following space, or (b) a single character > not followed by a space.

+

The following rules define [block quotes]:

+
    +
  1. +

    Basic case. If a string of lines Ls constitute a sequence +of blocks Bs, then the result of prepending a [block quote +marker] to the beginning of each line in Ls +is a block quote containing Bs.

    +
    2. +
  2. +

    Laziness. If a string of lines Ls constitute a block +quote with contents Bs, then the result of deleting +the initial [block quote marker] from one or +more lines in which the next [non-whitespace character] after the [block +quote marker] is [paragraph continuation +text] is a block quote with Bs as its content. +Paragraph continuation text is text +that will be parsed as part of the content of a paragraph, but does +not occur at the beginning of the paragraph.

    +
    3. +
  3. +

    Consecutiveness. A document cannot contain two [block +quotes] in a row unless there is a [blank line] between them.

    +
    4. +
+

Nothing else counts as a block quote.

+

Here is a simple example:

+
+
> # Foo
+> bar
+> baz
+.
+<blockquote>
+<h1>Foo</h1>
+<p>bar
+baz</p>
+</blockquote>
+ +
+

The spaces after the > characters can be omitted:

+
+
># Foo
+>bar
+> baz
+.
+<blockquote>
+<h1>Foo</h1>
+<p>bar
+baz</p>
+</blockquote>
+ +
+

The > characters can be indented 1-3 spaces:

+
+
   > # Foo
+   > bar
+ > baz
+.
+<blockquote>
+<h1>Foo</h1>
+<p>bar
+baz</p>
+</blockquote>
+ +
+

Four spaces gives us a code block:

+
+
    > # Foo
+    > bar
+    > baz
+.
+<pre><code>&gt; # Foo
+&gt; bar
+&gt; baz
+</code></pre>
+ +
+

The Laziness clause allows us to omit the > before +[paragraph continuation text]:

+
+
> # Foo
+> bar
+baz
+.
+<blockquote>
+<h1>Foo</h1>
+<p>bar
+baz</p>
+</blockquote>
+ +
+

A block quote can contain some lazy and some non-lazy +continuation lines:

+
+
> bar
+baz
+> foo
+.
+<blockquote>
+<p>bar
+baz
+foo</p>
+</blockquote>
+ +
+

Laziness only applies to lines that would have been continuations of +paragraphs had they been prepended with [block quote markers]. +For example, the > cannot be omitted in the second line of

+
+
> foo
+> ---
+ +
+

without changing the meaning:

+
+
> foo
+---
+.
+<blockquote>
+<p>foo</p>
+</blockquote>
+<hr />
+ +
+

Similarly, if we omit the > in the second line of

+
+
> - foo
+> - bar
+ +
+

then the block quote ends after the first line:

+
+
> - foo
+- bar
+.
+<blockquote>
+<ul>
+<li>foo</li>
+</ul>
+</blockquote>
+<ul>
+<li>bar</li>
+</ul>
+ +
+

For the same reason, we can't omit the > in front of +subsequent lines of an indented or fenced code block:

+
+
>     foo
+    bar
+.
+<blockquote>
+<pre><code>foo
+</code></pre>
+</blockquote>
+<pre><code>bar
+</code></pre>
+ +
+
+
> ```
+foo
+```
+.
+<blockquote>
+<pre><code></code></pre>
+</blockquote>
+<p>foo</p>
+<pre><code></code></pre>
+ +
+

Note that in the following case, we have a [lazy +continuation line]:

+
+
> foo
+    - bar
+.
+<blockquote>
+<p>foo
+- bar</p>
+</blockquote>
+ +
+

To see why, note that in

+
+
> foo
+>     - bar
+ +
+

the - bar is indented too far to start a list, and can't +be an indented code block because indented code blocks cannot +interrupt paragraphs, so it is [paragraph continuation text].

+

A block quote can be empty:

+
+
>
+.
+<blockquote>
+</blockquote>
+ +
+
+
>
+>  
+> 
+.
+<blockquote>
+</blockquote>
+ +
+

A block quote can have initial or final blank lines:

+
+
>
+> foo
+>  
+.
+<blockquote>
+<p>foo</p>
+</blockquote>
+ +
+

A blank line always separates block quotes:

+
+
> foo
+
+> bar
+.
+<blockquote>
+<p>foo</p>
+</blockquote>
+<blockquote>
+<p>bar</p>
+</blockquote>
+ +
+

(Most current Markdown implementations, including John Gruber's +original Markdown.pl, will parse this example as a single block quote +with two paragraphs. But it seems better to allow the author to decide +whether two block quotes or one are wanted.)

+

Consecutiveness means that if we put these block quotes together, +we get a single block quote:

+
+
> foo
+> bar
+.
+<blockquote>
+<p>foo
+bar</p>
+</blockquote>
+ +
+

To get a block quote with two paragraphs, use:

+
+
> foo
+>
+> bar
+.
+<blockquote>
+<p>foo</p>
+<p>bar</p>
+</blockquote>
+ +
+

Block quotes can interrupt paragraphs:

+
+
foo
+> bar
+.
+<p>foo</p>
+<blockquote>
+<p>bar</p>
+</blockquote>
+ +
+

In general, blank lines are not needed before or after block +quotes:

+
+
> aaa
+***
+> bbb
+.
+<blockquote>
+<p>aaa</p>
+</blockquote>
+<hr />
+<blockquote>
+<p>bbb</p>
+</blockquote>
+ +
+

However, because of laziness, a blank line is needed between +a block quote and a following paragraph:

+
+
> bar
+baz
+.
+<blockquote>
+<p>bar
+baz</p>
+</blockquote>
+ +
+
+
> bar
+
+baz
+.
+<blockquote>
+<p>bar</p>
+</blockquote>
+<p>baz</p>
+ +
+
+
> bar
+>
+baz
+.
+<blockquote>
+<p>bar</p>
+</blockquote>
+<p>baz</p>
+ +
+

It is a consequence of the Laziness rule that any number +of initial >s may be omitted on a continuation line of a +nested block quote:

+
+
> > > foo
+bar
+.
+<blockquote>
+<blockquote>
+<blockquote>
+<p>foo
+bar</p>
+</blockquote>
+</blockquote>
+</blockquote>
+ +
+
+
>>> foo
+> bar
+>>baz
+.
+<blockquote>
+<blockquote>
+<blockquote>
+<p>foo
+bar
+baz</p>
+</blockquote>
+</blockquote>
+</blockquote>
+ +
+

When including an indented code block in a block quote, +remember that the [block quote marker] includes +both the > and a following space. So five spaces are needed after +the >:

+
+
>     code
+
+>    not code
+.
+<blockquote>
+<pre><code>code
+</code></pre>
+</blockquote>
+<blockquote>
+<p>not code</p>
+</blockquote>
+ +
+

+List items

+

A list marker is a +[bullet list marker] or an [ordered list marker].

+

A bullet list marker +is a -, +, or * character.

+

An ordered list marker +is a sequence of 1--9 arabic digits (0-9), followed by either a +. character or a ) character. (The reason for the length +limit is that with 10 digits we start seeing integer overflows +in some browsers.)

+

The following rules define [list items]:

+
    +
  1. +

    Basic case. If a sequence of lines Ls constitute a sequence of +blocks Bs starting with a [non-whitespace character], and M is a +list marker of width W followed by 1 ≀ N ≀ 4 spaces, then the result +of prepending M and the following spaces to the first line of +Ls, and indenting subsequent lines of Ls by W + N spaces, is a +list item with Bs as its contents. The type of the list item +(bullet or ordered) is determined by the type of its list marker. +If the list item is ordered, then it is also assigned a start +number, based on the ordered list marker.

    +

    Exceptions:

    +
      +
    1. When the first list item in a [list] interrupts +a paragraph---that is, when it starts on a line that would +otherwise count as [paragraph continuation text]---then (a) +the lines Ls must not begin with a blank line, and (b) if +the list item is ordered, the start number must be 1.
      2. +
    2. If any line is a [thematic break][thematic breaks] then +that line is not a list item.
      3. +
    +
    2. +
+

For example, let Ls be the lines

+
+
A paragraph
+with two lines.
+
+    indented code
+
+> A block quote.
+.
+<p>A paragraph
+with two lines.</p>
+<pre><code>indented code
+</code></pre>
+<blockquote>
+<p>A block quote.</p>
+</blockquote>
+ +
+

And let M be the marker 1., and N = 2. Then rule #1 says +that the following is an ordered list item with start number 1, +and the same contents as Ls:

+
+
1.  A paragraph
+    with two lines.
+
+        indented code
+
+    > A block quote.
+.
+<ol>
+<li>
+<p>A paragraph
+with two lines.</p>
+<pre><code>indented code
+</code></pre>
+<blockquote>
+<p>A block quote.</p>
+</blockquote>
+</li>
+</ol>
+ +
+

The most important thing to notice is that the position of +the text after the list marker determines how much indentation +is needed in subsequent blocks in the list item. If the list +marker takes up two spaces, and there are three spaces between +the list marker and the next [non-whitespace character], then blocks +must be indented five spaces in order to fall under the list +item.

+

Here are some examples showing how far content must be indented to be +put under the list item:

+
+
- one
+
+ two
+.
+<ul>
+<li>one</li>
+</ul>
+<p>two</p>
+ +
+
+
- one
+
+  two
+.
+<ul>
+<li>
+<p>one</p>
+<p>two</p>
+</li>
+</ul>
+ +
+
+
 -    one
+
+     two
+.
+<ul>
+<li>one</li>
+</ul>
+<pre><code> two
+</code></pre>
+ +
+
+
 -    one
+
+      two
+.
+<ul>
+<li>
+<p>one</p>
+<p>two</p>
+</li>
+</ul>
+ +
+

It is tempting to think of this in terms of columns: the continuation +blocks must be indented at least to the column of the first +[non-whitespace character] after the list marker. However, that is not quite right. +The spaces after the list marker determine how much relative indentation +is needed. Which column this indentation reaches will depend on +how the list item is embedded in other constructions, as shown by +this example:

+
+
   > > 1.  one
+>>
+>>     two
+.
+<blockquote>
+<blockquote>
+<ol>
+<li>
+<p>one</p>
+<p>two</p>
+</li>
+</ol>
+</blockquote>
+</blockquote>
+ +
+

Here two occurs in the same column as the list marker 1., +but is actually contained in the list item, because there is +sufficient indentation after the last containing blockquote marker.

+

The converse is also possible. In the following example, the word two +occurs far to the right of the initial text of the list item, one, but +it is not considered part of the list item, because it is not indented +far enough past the blockquote marker:

+
+
>>- one
+>>
+  >  > two
+.
+<blockquote>
+<blockquote>
+<ul>
+<li>one</li>
+</ul>
+<p>two</p>
+</blockquote>
+</blockquote>
+ +
+

Note that at least one space is needed between the list marker and +any following content, so these are not list items:

+
+
-one
+
+2.two
+.
+<p>-one</p>
+<p>2.two</p>
+ +
+

A list item may contain blocks that are separated by more than +one blank line.

+
+
- foo
+
+
+  bar
+.
+<ul>
+<li>
+<p>foo</p>
+<p>bar</p>
+</li>
+</ul>
+ +
+

A list item may contain any kind of block:

+
+
1.  foo
+
+    ```
+    bar
+    ```
+
+    baz
+
+    > bam
+.
+<ol>
+<li>
+<p>foo</p>
+<pre><code>bar
+</code></pre>
+<p>baz</p>
+<blockquote>
+<p>bam</p>
+</blockquote>
+</li>
+</ol>
+ +
+

A list item that contains an indented code block will preserve +empty lines within the code block verbatim.

+
+
- Foo
+
+      bar
+
+
+      baz
+.
+<ul>
+<li>
+<p>Foo</p>
+<pre><code>bar
+
+
+baz
+</code></pre>
+</li>
+</ul>
+ +
+

Note that ordered list start numbers must be nine digits or less:

+
+
123456789. ok
+.
+<ol start="123456789">
+<li>ok</li>
+</ol>
+ +
+
+
1234567890. not ok
+.
+<p>1234567890. not ok</p>
+ +
+

A start number may begin with 0s:

+
+
0. ok
+.
+<ol start="0">
+<li>ok</li>
+</ol>
+ +
+
+
003. ok
+.
+<ol start="3">
+<li>ok</li>
+</ol>
+ +
+

A start number may not be negative:

+
+
-1. not ok
+.
+<p>-1. not ok</p>
+ +
+
    +
  1. +Item starting with indented code. If a sequence of lines Ls +constitute a sequence of blocks Bs starting with an indented code +block, and M is a list marker of width W followed by +one space, then the result of prepending M and the following +space to the first line of Ls, and indenting subsequent lines of +Ls by W + 1 spaces, is a list item with Bs as its contents. +If a line is empty, then it need not be indented. The type of the +list item (bullet or ordered) is determined by the type of its list +marker. If the list item is ordered, then it is also assigned a +start number, based on the ordered list marker.
    2. +
+

An indented code block will have to be indented four spaces beyond +the edge of the region where text will be included in the list item. +In the following case that is 6 spaces:

+
+
- foo
+
+      bar
+.
+<ul>
+<li>
+<p>foo</p>
+<pre><code>bar
+</code></pre>
+</li>
+</ul>
+ +
+

And in this case it is 11 spaces:

+
+
  10.  foo
+
+           bar
+.
+<ol start="10">
+<li>
+<p>foo</p>
+<pre><code>bar
+</code></pre>
+</li>
+</ol>
+ +
+

If the first block in the list item is an indented code block, +then by rule #2, the contents must be indented one space after the +list marker:

+
+
    indented code
+
+paragraph
+
+    more code
+.
+<pre><code>indented code
+</code></pre>
+<p>paragraph</p>
+<pre><code>more code
+</code></pre>
+ +
+
+
1.     indented code
+
+   paragraph
+
+       more code
+.
+<ol>
+<li>
+<pre><code>indented code
+</code></pre>
+<p>paragraph</p>
+<pre><code>more code
+</code></pre>
+</li>
+</ol>
+ +
+

Note that an additional space indent is interpreted as space +inside the code block:

+
+
1.      indented code
+
+   paragraph
+
+       more code
+.
+<ol>
+<li>
+<pre><code> indented code
+</code></pre>
+<p>paragraph</p>
+<pre><code>more code
+</code></pre>
+</li>
+</ol>
+ +
+

Note that rules #1 and #2 only apply to two cases: (a) cases +in which the lines to be included in a list item begin with a +[non-whitespace character], and (b) cases in which +they begin with an indented code +block. In a case like the following, where the first block begins with +a three-space indent, the rules do not allow us to form a list item by +indenting the whole thing and prepending a list marker:

+
+
   foo
+
+bar
+.
+<p>foo</p>
+<p>bar</p>
+ +
+
+
-    foo
+
+  bar
+.
+<ul>
+<li>foo</li>
+</ul>
+<p>bar</p>
+ +
+

This is not a significant restriction, because when a block begins +with 1-3 spaces indent, the indentation can always be removed without +a change in interpretation, allowing rule #1 to be applied. So, in +the above case:

+
+
-  foo
+
+   bar
+.
+<ul>
+<li>
+<p>foo</p>
+<p>bar</p>
+</li>
+</ul>
+ +
+
    +
  1. +Item starting with a blank line. If a sequence of lines Ls +starting with a single [blank line] constitute a (possibly empty) +sequence of blocks Bs, not separated from each other by more than +one blank line, and M is a list marker of width W, +then the result of prepending M to the first line of Ls, and +indenting subsequent lines of Ls by W + 1 spaces, is a list +item with Bs as its contents. +If a line is empty, then it need not be indented. The type of the +list item (bullet or ordered) is determined by the type of its list +marker. If the list item is ordered, then it is also assigned a +start number, based on the ordered list marker.
    2. +
+

Here are some list items that start with a blank line but are not empty:

+
+
-
+  foo
+-
+  ```
+  bar
+  ```
+-
+      baz
+.
+<ul>
+<li>foo</li>
+<li>
+<pre><code>bar
+</code></pre>
+</li>
+<li>
+<pre><code>baz
+</code></pre>
+</li>
+</ul>
+ +
+

When the list item starts with a blank line, the number of spaces +following the list marker doesn't change the required indentation:

+
+
-   
+  foo
+.
+<ul>
+<li>foo</li>
+</ul>
+ +
+

A list item can begin with at most one blank line. +In the following example, foo is not part of the list +item:

+
+
-
+
+  foo
+.
+<ul>
+<li></li>
+</ul>
+<p>foo</p>
+ +
+

Here is an empty bullet list item:

+
+
- foo
+-
+- bar
+.
+<ul>
+<li>foo</li>
+<li></li>
+<li>bar</li>
+</ul>
+ +
+

It does not matter whether there are spaces following the [list marker]:

+
+
- foo
+-   
+- bar
+.
+<ul>
+<li>foo</li>
+<li></li>
+<li>bar</li>
+</ul>
+ +
+

Here is an empty ordered list item:

+
+
1. foo
+2.
+3. bar
+.
+<ol>
+<li>foo</li>
+<li></li>
+<li>bar</li>
+</ol>
+ +
+

A list may start or end with an empty list item:

+
+
*
+.
+<ul>
+<li></li>
+</ul>
+ +
+

However, an empty list item cannot interrupt a paragraph:

+
+
foo
+*
+
+foo
+1.
+.
+<p>foo
+*</p>
+<p>foo
+1.</p>
+ +
+
    +
  1. +Indentation. If a sequence of lines Ls constitutes a list item +according to rule #1, #2, or #3, then the result of indenting each line +of Ls by 1-3 spaces (the same for each line) also constitutes a +list item with the same contents and attributes. If a line is +empty, then it need not be indented.
    2. +
+

Indented one space:

+
+
 1.  A paragraph
+     with two lines.
+
+         indented code
+
+     > A block quote.
+.
+<ol>
+<li>
+<p>A paragraph
+with two lines.</p>
+<pre><code>indented code
+</code></pre>
+<blockquote>
+<p>A block quote.</p>
+</blockquote>
+</li>
+</ol>
+ +
+

Indented two spaces:

+
+
  1.  A paragraph
+      with two lines.
+
+          indented code
+
+      > A block quote.
+.
+<ol>
+<li>
+<p>A paragraph
+with two lines.</p>
+<pre><code>indented code
+</code></pre>
+<blockquote>
+<p>A block quote.</p>
+</blockquote>
+</li>
+</ol>
+ +
+

Indented three spaces:

+
+
   1.  A paragraph
+       with two lines.
+
+           indented code
+
+       > A block quote.
+.
+<ol>
+<li>
+<p>A paragraph
+with two lines.</p>
+<pre><code>indented code
+</code></pre>
+<blockquote>
+<p>A block quote.</p>
+</blockquote>
+</li>
+</ol>
+ +
+

Four spaces indent gives a code block:

+
+
    1.  A paragraph
+        with two lines.
+
+            indented code
+
+        > A block quote.
+.
+<pre><code>1.  A paragraph
+    with two lines.
+
+        indented code
+
+    &gt; A block quote.
+</code></pre>
+ +
+
    +
  1. +Laziness. If a string of lines Ls constitute a list +item with contents Bs, then the result of deleting +some or all of the indentation from one or more lines in which the +next [non-whitespace character] after the indentation is +[paragraph continuation text] is a +list item with the same contents and attributes. The unindented +lines are called +lazy continuation lines.
    2. +
+

Here is an example with [lazy continuation lines]:

+
+
  1.  A paragraph
+with two lines.
+
+          indented code
+
+      > A block quote.
+.
+<ol>
+<li>
+<p>A paragraph
+with two lines.</p>
+<pre><code>indented code
+</code></pre>
+<blockquote>
+<p>A block quote.</p>
+</blockquote>
+</li>
+</ol>
+ +
+

Indentation can be partially deleted:

+
+
  1.  A paragraph
+    with two lines.
+.
+<ol>
+<li>A paragraph
+with two lines.</li>
+</ol>
+ +
+

These examples show how laziness can work in nested structures:

+
+
> 1. > Blockquote
+continued here.
+.
+<blockquote>
+<ol>
+<li>
+<blockquote>
+<p>Blockquote
+continued here.</p>
+</blockquote>
+</li>
+</ol>
+</blockquote>
+ +
+
+
> 1. > Blockquote
+> continued here.
+.
+<blockquote>
+<ol>
+<li>
+<blockquote>
+<p>Blockquote
+continued here.</p>
+</blockquote>
+</li>
+</ol>
+</blockquote>
+ +
+
    +
  1. +That's all. Nothing that is not counted as a list item by rules +#1--5 counts as a list item.
    2. +
+

The rules for sublists follow from the general rules +[above][List items]. A sublist must be indented the same number +of spaces a paragraph would need to be in order to be included +in the list item.

+

So, in this case we need two spaces indent:

+
+
- foo
+  - bar
+    - baz
+      - boo
+.
+<ul>
+<li>foo
+<ul>
+<li>bar
+<ul>
+<li>baz
+<ul>
+<li>boo</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+ +
+

One is not enough:

+
+
- foo
+ - bar
+  - baz
+   - boo
+.
+<ul>
+<li>foo</li>
+<li>bar</li>
+<li>baz</li>
+<li>boo</li>
+</ul>
+ +
+

Here we need four, because the list marker is wider:

+
+
10) foo
+    - bar
+.
+<ol start="10">
+<li>foo
+<ul>
+<li>bar</li>
+</ul>
+</li>
+</ol>
+ +
+

Three is not enough:

+
+
10) foo
+   - bar
+.
+<ol start="10">
+<li>foo</li>
+</ol>
+<ul>
+<li>bar</li>
+</ul>
+ +
+

A list may be the first block in a list item:

+
+
- - foo
+.
+<ul>
+<li>
+<ul>
+<li>foo</li>
+</ul>
+</li>
+</ul>
+ +
+
+
1. - 2. foo
+.
+<ol>
+<li>
+<ul>
+<li>
+<ol start="2">
+<li>foo</li>
+</ol>
+</li>
+</ul>
+</li>
+</ol>
+ +
+

A list item can contain a heading:

+
+
- # Foo
+- Bar
+  ---
+  baz
+.
+<ul>
+<li>
+<h1>Foo</h1>
+</li>
+<li>
+<h2>Bar</h2>
+baz</li>
+</ul>
+ +
+

+Motivation

+

John Gruber's Markdown spec says the following about list items:

+
    +
  1. +

    "List markers typically start at the left margin, but may be indented +by up to three spaces. List markers must be followed by one or more +spaces or a tab."

    +
    2. +
  2. +

    "To make lists look nice, you can wrap items with hanging indents.... +But if you don't want to, you don't have to."

    +
    3. +
  3. +

    "List items may consist of multiple paragraphs. Each subsequent +paragraph in a list item must be indented by either 4 spaces or one +tab."

    +
    4. +
  4. +

    "It looks nice if you indent every line of the subsequent paragraphs, +but here again, Markdown will allow you to be lazy."

    +
    5. +
  5. +

    "To put a blockquote within a list item, the blockquote's > +delimiters need to be indented."

    +
    6. +
  6. +

    "To put a code block within a list item, the code block needs to be +indented twice — 8 spaces or two tabs."

    +
    7. +
+

These rules specify that a paragraph under a list item must be indented +four spaces (presumably, from the left margin, rather than the start of +the list marker, but this is not said), and that code under a list item +must be indented eight spaces instead of the usual four. They also say +that a block quote must be indented, but not by how much; however, the +example given has four spaces indentation. Although nothing is said +about other kinds of block-level content, it is certainly reasonable to +infer that all block elements under a list item, including other +lists, must be indented four spaces. This principle has been called the +four-space rule.

+

The four-space rule is clear and principled, and if the reference +implementation Markdown.pl had followed it, it probably would have +become the standard. However, Markdown.pl allowed paragraphs and +sublists to start with only two spaces indentation, at least on the +outer level. Worse, its behavior was inconsistent: a sublist of an +outer-level list needed two spaces indentation, but a sublist of this +sublist needed three spaces. It is not surprising, then, that different +implementations of Markdown have developed very different rules for +determining what comes under a list item. (Pandoc and python-Markdown, +for example, stuck with Gruber's syntax description and the four-space +rule, while discount, redcarpet, marked, PHP Markdown, and others +followed Markdown.pl's behavior more closely.)

+

Unfortunately, given the divergences between implementations, there +is no way to give a spec for list items that will be guaranteed not +to break any existing documents. However, the spec given here should +correctly handle lists formatted with either the four-space rule or +the more forgiving Markdown.pl behavior, provided they are laid out +in a way that is natural for a human to read.

+

The strategy here is to let the width and indentation of the list marker +determine the indentation necessary for blocks to fall under the list +item, rather than having a fixed and arbitrary number. The writer can +think of the body of the list item as a unit which gets indented to the +right enough to fit the list marker (and any indentation on the list +marker). (The laziness rule, #5, then allows continuation lines to be +unindented if needed.)

+

This rule is superior, we claim, to any rule requiring a fixed level of +indentation from the margin. The four-space rule is clear but +unnatural. It is quite unintuitive that

+
+
- foo
+
+  bar
+
+  - baz
+ +
+

should be parsed as two lists with an intervening paragraph,

+
+
<ul>
+<li>foo</li>
+</ul>
+<p>bar</p>
+<ul>
+<li>baz</li>
+</ul>
+ +
+

as the four-space rule demands, rather than a single list,

+
+
<ul>
+<li>
+<p>foo</p>
+<p>bar</p>
+<ul>
+<li>baz</li>
+</ul>
+</li>
+</ul>
+ +
+

The choice of four spaces is arbitrary. It can be learned, but it is +not likely to be guessed, and it trips up beginners regularly.

+

Would it help to adopt a two-space rule? The problem is that such +a rule, together with the rule allowing 1--3 spaces indentation of the +initial list marker, allows text that is indented less than the +original list marker to be included in the list item. For example, +Markdown.pl parses

+
+
   - one
+
+  two
+ +
+

as a single list item, with two a continuation paragraph:

+
+
<ul>
+<li>
+<p>one</p>
+<p>two</p>
+</li>
+</ul>
+ +
+

and similarly

+
+
>   - one
+>
+>  two
+ +
+

as

+
+
<blockquote>
+<ul>
+<li>
+<p>one</p>
+<p>two</p>
+</li>
+</ul>
+</blockquote>
+ +
+

This is extremely unintuitive.

+

Rather than requiring a fixed indent from the margin, we could require +a fixed indent (say, two spaces, or even one space) from the list marker (which +may itself be indented). This proposal would remove the last anomaly +discussed. Unlike the spec presented above, it would count the following +as a list item with a subparagraph, even though the paragraph bar +is not indented as far as the first paragraph foo:

+
+
 10. foo
+
+   bar
+ +
+

Arguably this text does read like a list item with bar as a subparagraph, +which may count in favor of the proposal. However, on this proposal indented +code would have to be indented six spaces after the list marker. And this +would break a lot of existing Markdown, which has the pattern:

+
+
1.  foo
+
+        indented code
+ +
+

where the code is indented eight spaces. The spec above, by contrast, will +parse this text as expected, since the code block's indentation is measured +from the beginning of foo.

+

The one case that needs special treatment is a list item that starts +with indented code. How much indentation is required in that case, since +we don't have a "first paragraph" to measure from? Rule #2 simply stipulates +that in such cases, we require one space indentation from the list marker +(and then the normal four spaces for the indented code). This will match the +four-space rule in cases where the list marker plus its initial indentation +takes four spaces (a common case), but diverge in other cases.

+
+

+Task list items (extension)

+

GFM enables the tasklist extension, where an additional processing step is +performed on [list items].

+

A task list item is a [list item][list items] where the first block in it +is a paragraph which begins with a [task list item marker] and at least one +whitespace character before any other content.

+

A task list item marker consists of an optional number of spaces, a left +bracket ([), either a whitespace character or the letter x in either +lowercase or uppercase, and then a right bracket (]).

+

When rendered, the [task list item marker] is replaced with a semantic checkbox element; +in an HTML output, this would be an <input type="checkbox"> element.

+

If the character between the brackets is a whitespace character, the checkbox +is unchecked. Otherwise, the checkbox is checked.

+

This spec does not define how the checkbox elements are interacted with: in practice, +implementors are free to render the checkboxes as disabled or inmutable elements, +or they may dynamically handle dynamic interactions (i.e. checking, unchecking) in +the final rendered document.

+
+
- [ ] foo
+- [x] bar
+.
+<ul>
+<li><input disabled="" type="checkbox"> foo</li>
+<li><input checked="" disabled="" type="checkbox"> bar</li>
+</ul>
+ +
+

Task lists can be arbitrarily nested:

+
+
- [x] foo
+  - [ ] bar
+  - [x] baz
+- [ ] bim
+.
+<ul>
+<li><input checked="" disabled="" type="checkbox"> foo
+<ul>
+<li><input disabled="" type="checkbox"> bar</li>
+<li><input checked="" disabled="" type="checkbox"> baz</li>
+</ul>
+</li>
+<li><input disabled="" type="checkbox"> bim</li>
+</ul>
+ +
+
+

+Lists

+

A list is a sequence of one or more +list items [of the same type]. The list items +may be separated by any number of blank lines.

+

Two list items are of the same type +if they begin with a [list marker] of the same type. +Two list markers are of the +same type if (a) they are bullet list markers using the same character +(-, +, or *) or (b) they are ordered list numbers with the same +delimiter (either . or )).

+

A list is an ordered list +if its constituent list items begin with +[ordered list markers], and a +bullet list if its constituent list +items begin with [bullet list markers].

+

The start number +of an [ordered list] is determined by the list number of +its initial list item. The numbers of subsequent list items are +disregarded.

+

A list is loose if any of its constituent +list items are separated by blank lines, or if any of its constituent +list items directly contain two block-level elements with a blank line +between them. Otherwise a list is tight. +(The difference in HTML output is that paragraphs in a loose list are +wrapped in <p> tags, while paragraphs in a tight list are not.)

+

Changing the bullet or ordered list delimiter starts a new list:

+
+
- foo
+- bar
++ baz
+.
+<ul>
+<li>foo</li>
+<li>bar</li>
+</ul>
+<ul>
+<li>baz</li>
+</ul>
+ +
+
+
1. foo
+2. bar
+3) baz
+.
+<ol>
+<li>foo</li>
+<li>bar</li>
+</ol>
+<ol start="3">
+<li>baz</li>
+</ol>
+ +
+

In CommonMark, a list can interrupt a paragraph. That is, +no blank line is needed to separate a paragraph from a following +list:

+
+
Foo
+- bar
+- baz
+.
+<p>Foo</p>
+<ul>
+<li>bar</li>
+<li>baz</li>
+</ul>
+ +
+

Markdown.pl does not allow this, through fear of triggering a list +via a numeral in a hard-wrapped line:

+
+
The number of windows in my house is
+14.  The number of doors is 6.
+ +
+

Oddly, though, Markdown.pl does allow a blockquote to +interrupt a paragraph, even though the same considerations might +apply.

+

In CommonMark, we do allow lists to interrupt paragraphs, for +two reasons. First, it is natural and not uncommon for people +to start lists without blank lines:

+
+
I need to buy
+- new shoes
+- a coat
+- a plane ticket
+ +
+

Second, we are attracted to a

+
+

principle of uniformity: +if a chunk of text has a certain +meaning, it will continue to have the same meaning when put into a +container block (such as a list item or blockquote).

+
+

(Indeed, the spec for [list items] and [block quotes] presupposes +this principle.) This principle implies that if

+
+
  * I need to buy
+    - new shoes
+    - a coat
+    - a plane ticket
+ +
+

is a list item containing a paragraph followed by a nested sublist, +as all Markdown implementations agree it is (though the paragraph +may be rendered without <p> tags, since the list is "tight"), +then

+
+
I need to buy
+- new shoes
+- a coat
+- a plane ticket
+ +
+

by itself should be a paragraph followed by a nested sublist.

+

Since it is well established Markdown practice to allow lists to +interrupt paragraphs inside list items, the [principle of +uniformity] requires us to allow this outside list items as +well. (reStructuredText +takes a different approach, requiring blank lines before lists +even inside other list items.)

+

In order to solve of unwanted lists in paragraphs with +hard-wrapped numerals, we allow only lists starting with 1 to +interrupt paragraphs. Thus,

+
+
The number of windows in my house is
+14.  The number of doors is 6.
+.
+<p>The number of windows in my house is
+14.  The number of doors is 6.</p>
+ +
+

We may still get an unintended result in cases like

+
+
The number of windows in my house is
+1.  The number of doors is 6.
+.
+<p>The number of windows in my house is</p>
+<ol>
+<li>The number of doors is 6.</li>
+</ol>
+ +
+

but this rule should prevent most spurious list captures.

+

There can be any number of blank lines between items:

+
+
- foo
+
+- bar
+
+
+- baz
+.
+<ul>
+<li>
+<p>foo</p>
+</li>
+<li>
+<p>bar</p>
+</li>
+<li>
+<p>baz</p>
+</li>
+</ul>
+ +
+
+
- foo
+  - bar
+    - baz
+
+
+      bim
+.
+<ul>
+<li>foo
+<ul>
+<li>bar
+<ul>
+<li>
+<p>baz</p>
+<p>bim</p>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+ +
+

To separate consecutive lists of the same type, or to separate a +list from an indented code block that would otherwise be parsed +as a subparagraph of the final list item, you can insert a blank HTML +comment:

+
+
- foo
+- bar
+
+<!-- -->
+
+- baz
+- bim
+.
+<ul>
+<li>foo</li>
+<li>bar</li>
+</ul>
+<!-- -->
+<ul>
+<li>baz</li>
+<li>bim</li>
+</ul>
+ +
+
+
-   foo
+
+    notcode
+
+-   foo
+
+<!-- -->
+
+    code
+.
+<ul>
+<li>
+<p>foo</p>
+<p>notcode</p>
+</li>
+<li>
+<p>foo</p>
+</li>
+</ul>
+<!-- -->
+<pre><code>code
+</code></pre>
+ +
+

List items need not be indented to the same level. The following +list items will be treated as items at the same list level, +since none is indented enough to belong to the previous list +item:

+
+
- a
+ - b
+  - c
+   - d
+  - e
+ - f
+- g
+.
+<ul>
+<li>a</li>
+<li>b</li>
+<li>c</li>
+<li>d</li>
+<li>e</li>
+<li>f</li>
+<li>g</li>
+</ul>
+ +
+
+
1. a
+
+  2. b
+
+   3. c
+.
+<ol>
+<li>
+<p>a</p>
+</li>
+<li>
+<p>b</p>
+</li>
+<li>
+<p>c</p>
+</li>
+</ol>
+ +
+

Note, however, that list items may not be indented more than +three spaces. Here - e is treated as a paragraph continuation +line, because it is indented more than three spaces:

+
+
- a
+ - b
+  - c
+   - d
+    - e
+.
+<ul>
+<li>a</li>
+<li>b</li>
+<li>c</li>
+<li>d
+- e</li>
+</ul>
+ +
+

And here, 3. c is treated as in indented code block, +because it is indented four spaces and preceded by a +blank line.

+
+
1. a
+
+  2. b
+
+    3. c
+.
+<ol>
+<li>
+<p>a</p>
+</li>
+<li>
+<p>b</p>
+</li>
+</ol>
+<pre><code>3. c
+</code></pre>
+ +
+

This is a loose list, because there is a blank line between +two of the list items:

+
+
- a
+- b
+
+- c
+.
+<ul>
+<li>
+<p>a</p>
+</li>
+<li>
+<p>b</p>
+</li>
+<li>
+<p>c</p>
+</li>
+</ul>
+ +
+

So is this, with a empty second item:

+
+
* a
+*
+
+* c
+.
+<ul>
+<li>
+<p>a</p>
+</li>
+<li></li>
+<li>
+<p>c</p>
+</li>
+</ul>
+ +
+

These are loose lists, even though there is no space between the items, +because one of the items directly contains two block-level elements +with a blank line between them:

+
+
- a
+- b
+
+  c
+- d
+.
+<ul>
+<li>
+<p>a</p>
+</li>
+<li>
+<p>b</p>
+<p>c</p>
+</li>
+<li>
+<p>d</p>
+</li>
+</ul>
+ +
+
+
- a
+- b
+
+  [ref]: /url
+- d
+.
+<ul>
+<li>
+<p>a</p>
+</li>
+<li>
+<p>b</p>
+</li>
+<li>
+<p>d</p>
+</li>
+</ul>
+ +
+

This is a tight list, because the blank lines are in a code block:

+
+
- a
+- ```
+  b
+
+
+  ```
+- c
+.
+<ul>
+<li>a</li>
+<li>
+<pre><code>b
+
+
+</code></pre>
+</li>
+<li>c</li>
+</ul>
+ +
+

This is a tight list, because the blank line is between two +paragraphs of a sublist. So the sublist is loose while +the outer list is tight:

+
+
- a
+  - b
+
+    c
+- d
+.
+<ul>
+<li>a
+<ul>
+<li>
+<p>b</p>
+<p>c</p>
+</li>
+</ul>
+</li>
+<li>d</li>
+</ul>
+ +
+

This is a tight list, because the blank line is inside the +block quote:

+
+
* a
+  > b
+  >
+* c
+.
+<ul>
+<li>a
+<blockquote>
+<p>b</p>
+</blockquote>
+</li>
+<li>c</li>
+</ul>
+ +
+

This list is tight, because the consecutive block elements +are not separated by blank lines:

+
+
- a
+  > b
+  ```
+  c
+  ```
+- d
+.
+<ul>
+<li>a
+<blockquote>
+<p>b</p>
+</blockquote>
+<pre><code>c
+</code></pre>
+</li>
+<li>d</li>
+</ul>
+ +
+

A single-paragraph list is tight:

+
+
- a
+.
+<ul>
+<li>a</li>
+</ul>
+ +
+
+
- a
+  - b
+.
+<ul>
+<li>a
+<ul>
+<li>b</li>
+</ul>
+</li>
+</ul>
+ +
+

This list is loose, because of the blank line between the +two block elements in the list item:

+
+
1. ```
+   foo
+   ```
+
+   bar
+.
+<ol>
+<li>
+<pre><code>foo
+</code></pre>
+<p>bar</p>
+</li>
+</ol>
+ +
+

Here the outer list is loose, the inner list tight:

+
+
* foo
+  * bar
+
+  baz
+.
+<ul>
+<li>
+<p>foo</p>
+<ul>
+<li>bar</li>
+</ul>
+<p>baz</p>
+</li>
+</ul>
+ +
+
+
- a
+  - b
+  - c
+
+- d
+  - e
+  - f
+.
+<ul>
+<li>
+<p>a</p>
+<ul>
+<li>b</li>
+<li>c</li>
+</ul>
+</li>
+<li>
+<p>d</p>
+<ul>
+<li>e</li>
+<li>f</li>
+</ul>
+</li>
+</ul>
+ +
+

+Inlines

+

Inlines are parsed sequentially from the beginning of the character +stream to the end (left to right, in left-to-right languages). +Thus, for example, in

+
+
`hi`lo`
+.
+<p><code>hi</code>lo`</p>
+ +
+

hi is parsed as code, leaving the backtick at the end as a literal +backtick.

+

+Backslash escapes

+

Any ASCII punctuation character may be backslash-escaped:

+
+
\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~
+.
+<p>!&quot;#$%&amp;'()*+,-./:;&lt;=&gt;?@[\]^_`{|}~</p>
+ +
+

Backslashes before other characters are treated as literal +backslashes:

+
+
\→\A\a\ \3\φ\«
+.
+<p>\→\A\a\ \3\φ\«</p>
+ +
+

Escaped characters are treated as regular characters and do +not have their usual Markdown meanings:

+
+
\*not emphasized*
+\<br/> not a tag
+\[not a link](/foo)
+\`not code`
+1\. not a list
+\* not a list
+\# not a heading
+\[foo]: /url "not a reference"
+\&ouml; not a character entity
+.
+<p>*not emphasized*
+&lt;br/&gt; not a tag
+[not a link](/foo)
+`not code`
+1. not a list
+* not a list
+# not a heading
+[foo]: /url &quot;not a reference&quot;
+&amp;ouml; not a character entity</p>
+ +
+

If a backslash is itself escaped, the following character is not:

+
+
\\*emphasis*
+.
+<p>\<em>emphasis</em></p>
+ +
+

A backslash at the end of the line is a [hard line break]:

+
+
foo\
+bar
+.
+<p>foo<br />
+bar</p>
+ +
+

Backslash escapes do not work in code blocks, code spans, autolinks, or +raw HTML:

+
+
`` \[\` ``
+.
+<p><code>\[\`</code></p>
+ +
+
+
    \[\]
+.
+<pre><code>\[\]
+</code></pre>
+ +
+
+
~~~
+\[\]
+~~~
+.
+<pre><code>\[\]
+</code></pre>
+ +
+
+
<http://example.com?find=\*>
+.
+<p><a href="http://example.com?find=%5C*">http://example.com?find=\*</a></p>
+ +
+
+
<a href="/bar\/)">
+.
+<a href="/bar\/)">
+ +
+

But they work in all other contexts, including URLs and link titles, +link references, and [info strings] in [fenced code blocks]:

+
+
[foo](/bar\* "ti\*tle")
+.
+<p><a href="/bar*" title="ti*tle">foo</a></p>
+ +
+
+
[foo]
+
+[foo]: /bar\* "ti\*tle"
+.
+<p><a href="/bar*" title="ti*tle">foo</a></p>
+ +
+
+
``` foo\+bar
+foo
+```
+.
+<pre><code class="language-foo+bar">foo
+</code></pre>
+ +
+

+Entity and numeric character references

+

Valid HTML entity references and numeric character references +can be used in place of the corresponding Unicode character, +with the following exceptions:

+ +

Conforming CommonMark parsers need not store information about +whether a particular character was represented in the source +using a Unicode character or an entity reference.

+

Entity references consist of & + any of the valid +HTML5 entity names + ;. The +document https://html.spec.whatwg.org/multipage/entities.json +is used as an authoritative source for the valid entity +references and their corresponding code points.

+
+
&nbsp; &amp; &copy; &AElig; &Dcaron;
+&frac34; &HilbertSpace; &DifferentialD;
+&ClockwiseContourIntegral; &ngE;
+.
+<p>  &amp; © Æ Ď
+Ÿ ℋ ⅆ
+âˆČ ≧̞</p>
+ +
+

Decimal numeric character +references +consist of &# + a string of 1--7 arabic digits + ;. A +numeric character reference is parsed as the corresponding +Unicode character. Invalid Unicode code points will be replaced by +the REPLACEMENT CHARACTER (U+FFFD). For security reasons, +the code point U+0000 will also be replaced by U+FFFD.

+
+
&#35; &#1234; &#992; &#0;
+.
+<p># Ӓ Ï  ïżœ</p>
+ +
+

Hexadecimal numeric character +references consist of &# + +either X or x + a string of 1-6 hexadecimal digits + ;. +They too are parsed as the corresponding Unicode character (this +time specified with a hexadecimal numeral instead of decimal).

+
+
&#X22; &#XD06; &#xcab;
+.
+<p>&quot; àŽ† àČ«</p>
+ +
+

Here are some nonentities:

+
+
&nbsp &x; &#; &#x;
+&#987654321;
+&#abcdef0;
+&ThisIsNotDefined; &hi?;
+.
+<p>&amp;nbsp &amp;x; &amp;#; &amp;#x;
+&amp;#987654321;
+&amp;#abcdef0;
+&amp;ThisIsNotDefined; &amp;hi?;</p>
+ +
+

Although HTML5 does accept some entity references +without a trailing semicolon (such as &copy), these are not +recognized here, because it makes the grammar too ambiguous:

+
+
&copy
+.
+<p>&amp;copy</p>
+ +
+

Strings that are not on the list of HTML5 named entities are not +recognized as entity references either:

+
+
&MadeUpEntity;
+.
+<p>&amp;MadeUpEntity;</p>
+ +
+

Entity and numeric character references are recognized in any +context besides code spans or code blocks, including +URLs, [link titles], and [fenced code block][] [info strings]:

+
+
<a href="&ouml;&ouml;.html">
+.
+<a href="&ouml;&ouml;.html">
+ +
+
+
[foo](/f&ouml;&ouml; "f&ouml;&ouml;")
+.
+<p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p>
+ +
+
+
[foo]
+
+[foo]: /f&ouml;&ouml; "f&ouml;&ouml;"
+.
+<p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p>
+ +
+
+
``` f&ouml;&ouml;
+foo
+```
+.
+<pre><code class="language-föö">foo
+</code></pre>
+ +
+

Entity and numeric character references are treated as literal +text in code spans and code blocks:

+
+
`f&ouml;&ouml;`
+.
+<p><code>f&amp;ouml;&amp;ouml;</code></p>
+ +
+
+
    f&ouml;f&ouml;
+.
+<pre><code>f&amp;ouml;f&amp;ouml;
+</code></pre>
+ +
+

Entity and numeric character references cannot be used +in place of symbols indicating structure in CommonMark +documents.

+
+
&#42;foo&#42;
+*foo*
+.
+<p>*foo*
+<em>foo</em></p>
+ +
+
+
&#42; foo
+
+* foo
+.
+<p>* foo</p>
+<ul>
+<li>foo</li>
+</ul>
+ +
+
+
foo&#10;&#10;bar
+.
+<p>foo
+
+bar</p>
+ +
+
+
&#9;foo
+.
+<p>→foo</p>
+ +
+
+
[a](url &quot;tit&quot;)
+.
+<p>[a](url &quot;tit&quot;)</p>
+ +
+

+Code spans

+

A backtick string +is a string of one or more backtick characters (`) that is neither +preceded nor followed by a backtick.

+

A code span begins with a backtick string and ends with +a backtick string of equal length. The contents of the code span are +the characters between the two backtick strings, normalized in the +following ways:

+ +

This is a simple code span:

+
+
`foo`
+.
+<p><code>foo</code></p>
+ +
+

Here two backticks are used, because the code contains a backtick. +This example also illustrates stripping of a single leading and +trailing space:

+
+
`` foo ` bar ``
+.
+<p><code>foo ` bar</code></p>
+ +
+

This example shows the motivation for stripping leading and trailing +spaces:

+
+
` `` `
+.
+<p><code>``</code></p>
+ +
+

Note that only one space is stripped:

+
+
`  ``  `
+.
+<p><code> `` </code></p>
+ +
+

The stripping only happens if the space is on both +sides of the string:

+
+
` a`
+.
+<p><code> a</code></p>
+ +
+

Only [spaces], and not [unicode whitespace] in general, are +stripped in this way:

+
+
` b `
+.
+<p><code> b </code></p>
+ +
+

No stripping occurs if the code span contains only spaces:

+
+
` `
+`  `
+.
+<p><code> </code>
+<code>  </code></p>
+ +
+

[Line endings] are treated like spaces:

+
+
``
+foo
+bar  
+baz
+``
+.
+<p><code>foo bar   baz</code></p>
+ +
+
+
``
+foo 
+``
+.
+<p><code>foo </code></p>
+ +
+

Interior spaces are not collapsed:

+
+
`foo   bar 
+baz`
+.
+<p><code>foo   bar  baz</code></p>
+ +
+

Note that browsers will typically collapse consecutive spaces +when rendering <code> elements, so it is recommended that +the following CSS be used:

+
+
code{white-space: pre-wrap;}
+ +
+

Note that backslash escapes do not work in code spans. All backslashes +are treated literally:

+
+
`foo\`bar`
+.
+<p><code>foo\</code>bar`</p>
+ +
+

Backslash escapes are never needed, because one can always choose a +string of n backtick characters as delimiters, where the code does +not contain any strings of exactly n backtick characters.

+
+
``foo`bar``
+.
+<p><code>foo`bar</code></p>
+ +
+
+
` foo `` bar `
+.
+<p><code>foo `` bar</code></p>
+ +
+

Code span backticks have higher precedence than any other inline +constructs except HTML tags and autolinks. Thus, for example, this is +not parsed as emphasized text, since the second * is part of a code +span:

+
+
*foo`*`
+.
+<p>*foo<code>*</code></p>
+ +
+

And this is not parsed as a link:

+
+
[not a `link](/foo`)
+.
+<p>[not a <code>link](/foo</code>)</p>
+ +
+

Code spans, HTML tags, and autolinks have the same precedence. +Thus, this is code:

+
+
`<a href="`">`
+.
+<p><code>&lt;a href=&quot;</code>&quot;&gt;`</p>
+ +
+

But this is an HTML tag:

+
+
<a href="`">`
+.
+<p><a href="`">`</p>
+ +
+

And this is code:

+
+
`<http://foo.bar.`baz>`
+.
+<p><code>&lt;http://foo.bar.</code>baz&gt;`</p>
+ +
+

But this is an autolink:

+
+
<http://foo.bar.`baz>`
+.
+<p><a href="http://foo.bar.%60baz">http://foo.bar.`baz</a>`</p>
+ +
+

When a backtick string is not closed by a matching backtick string, +we just have literal backticks:

+
+
```foo``
+.
+<p>```foo``</p>
+ +
+
+
`foo
+.
+<p>`foo</p>
+ +
+

The following case also illustrates the need for opening and +closing backtick strings to be equal in length:

+
+
`foo``bar``
+.
+<p>`foo<code>bar</code></p>
+ +
+

+Emphasis and strong emphasis

+

John Gruber's original Markdown syntax +description says:

+
+

Markdown treats asterisks (*) and underscores (_) as indicators of +emphasis. Text wrapped with one * or _ will be wrapped with an HTML +<em> tag; double *'s or _'s will be wrapped with an HTML <strong> +tag.

+
+

This is enough for most users, but these rules leave much undecided, +especially when it comes to nested emphasis. The original +Markdown.pl test suite makes it clear that triple *** and +___ delimiters can be used for strong emphasis, and most +implementations have also allowed the following patterns:

+
+
***strong emph***
+***strong** in emph*
+***emph* in strong**
+**in strong *emph***
+*in emph **strong***
+ +
+

The following patterns are less widely supported, but the intent +is clear and they are useful (especially in contexts like bibliography +entries):

+
+
*emph *with emph* in it*
+**strong **with strong** in it**
+ +
+

Many implementations have also restricted intraword emphasis to +the * forms, to avoid unwanted emphasis in words containing +internal underscores. (It is best practice to put these in code +spans, but users often do not.)

+
+
internal emphasis: foo*bar*baz
+no emphasis: foo_bar_baz
+ +
+

The rules given below capture all of these patterns, while allowing +for efficient parsing strategies that do not backtrack.

+

First, some definitions. A delimiter run is either +a sequence of one or more * characters that is not preceded or +followed by a non-backslash-escaped * character, or a sequence +of one or more _ characters that is not preceded or followed by +a non-backslash-escaped _ character.

+

A left-flanking delimiter run is +a [delimiter run] that is (1) not followed by [Unicode whitespace], +and either (2a) not followed by a [punctuation character], or +(2b) followed by a [punctuation character] and +preceded by [Unicode whitespace] or a [punctuation character]. +For purposes of this definition, the beginning and the end of +the line count as Unicode whitespace.

+

A right-flanking delimiter run is +a [delimiter run] that is (1) not preceded by [Unicode whitespace], +and either (2a) not preceded by a [punctuation character], or +(2b) preceded by a [punctuation character] and +followed by [Unicode whitespace] or a [punctuation character]. +For purposes of this definition, the beginning and the end of +the line count as Unicode whitespace.

+

Here are some examples of delimiter runs.

+ +

(The idea of distinguishing left-flanking and right-flanking +delimiter runs based on the character before and the character +after comes from Roopesh Chander's +vfmd. +vfmd uses the terminology "emphasis indicator string" instead of "delimiter +run," and its rules for distinguishing left- and right-flanking runs +are a bit more complex than the ones given here.)

+

The following rules define emphasis and strong emphasis:

+
    +
  1. +

    A single * character can open emphasis +iff (if and only if) it is part of a [left-flanking delimiter run].

    +
    2. +
  2. +

    A single _ character [can open emphasis] iff +it is part of a [left-flanking delimiter run] +and either (a) not part of a [right-flanking delimiter run] +or (b) part of a [right-flanking delimiter run] +preceded by punctuation.

    +
    3. +
  3. +

    A single * character can close emphasis +iff it is part of a [right-flanking delimiter run].

    +
    4. +
  4. +

    A single _ character [can close emphasis] iff +it is part of a [right-flanking delimiter run] +and either (a) not part of a [left-flanking delimiter run] +or (b) part of a [left-flanking delimiter run] +followed by punctuation.

    +
    5. +
  5. +

    A double ** can open strong emphasis +iff it is part of a [left-flanking delimiter run].

    +
    6. +
  6. +

    A double __ [can open strong emphasis] iff +it is part of a [left-flanking delimiter run] +and either (a) not part of a [right-flanking delimiter run] +or (b) part of a [right-flanking delimiter run] +preceded by punctuation.

    +
    7. +
  7. +

    A double ** can close strong emphasis +iff it is part of a [right-flanking delimiter run].

    +
    8. +
  8. +

    A double __ [can close strong emphasis] iff +it is part of a [right-flanking delimiter run] +and either (a) not part of a [left-flanking delimiter run] +or (b) part of a [left-flanking delimiter run] +followed by punctuation.

    +
    9. +
  9. +

    Emphasis begins with a delimiter that [can open emphasis] and ends +with a delimiter that [can close emphasis], and that uses the same +character (_ or *) as the opening delimiter. The +opening and closing delimiters must belong to separate +[delimiter runs]. If one of the delimiters can both +open and close emphasis, then the sum of the lengths of the +delimiter runs containing the opening and closing delimiters +must not be a multiple of 3 unless both lengths are +multiples of 3.

    +
    10. +
  10. +

    Strong emphasis begins with a delimiter that +[can open strong emphasis] and ends with a delimiter that +[can close strong emphasis], and that uses the same character +(_ or *) as the opening delimiter. The +opening and closing delimiters must belong to separate +[delimiter runs]. If one of the delimiters can both open +and close strong emphasis, then the sum of the lengths of +the delimiter runs containing the opening and closing +delimiters must not be a multiple of 3 unless both lengths +are multiples of 3.

    +
    11. +
  11. +

    A literal * character cannot occur at the beginning or end of +*-delimited emphasis or **-delimited strong emphasis, unless it +is backslash-escaped.

    +
    12. +
  12. +

    A literal _ character cannot occur at the beginning or end of +_-delimited emphasis or __-delimited strong emphasis, unless it +is backslash-escaped.

    +
    13. +
+

Where rules 1--12 above are compatible with multiple parsings, +the following principles resolve ambiguity:

+
    +
  1. +

    The number of nestings should be minimized. Thus, for example, +an interpretation <strong>...</strong> is always preferred to +<em><em>...</em></em>.

    +
    2. +
  2. +

    An interpretation <em><strong>...</strong></em> is always +preferred to <strong><em>...</em></strong>.

    +
    3. +
  3. +

    When two potential emphasis or strong emphasis spans overlap, +so that the second begins before the first ends and ends after +the first ends, the first takes precedence. Thus, for example, +*foo _bar* baz_ is parsed as <em>foo _bar</em> baz_ rather +than *foo <em>bar* baz</em>.

    +
    4. +
  4. +

    When there are two potential emphasis or strong emphasis spans +with the same closing delimiter, the shorter one (the one that +opens later) takes precedence. Thus, for example, +**foo **bar baz** is parsed as **foo <strong>bar baz</strong> +rather than <strong>foo **bar baz</strong>.

    +
    5. +
  5. +

    Inline code spans, links, images, and HTML tags group more tightly +than emphasis. So, when there is a choice between an interpretation +that contains one of these elements and one that does not, the +former always wins. Thus, for example, *[foo*](bar) is +parsed as *<a href="bar">foo*</a> rather than as +<em>[foo</em>](bar).

    +
    6. +
+

These rules can be illustrated through a series of examples.

+

Rule 1:

+
+
*foo bar*
+.
+<p><em>foo bar</em></p>
+ +
+

This is not emphasis, because the opening * is followed by +whitespace, and hence not part of a [left-flanking delimiter run]:

+
+
a * foo bar*
+.
+<p>a * foo bar*</p>
+ +
+

This is not emphasis, because the opening * is preceded +by an alphanumeric and followed by punctuation, and hence +not part of a [left-flanking delimiter run]:

+
+
a*"foo"*
+.
+<p>a*&quot;foo&quot;*</p>
+ +
+

Unicode nonbreaking spaces count as whitespace, too:

+
+
* a *
+.
+<p>* a *</p>
+ +
+

Intraword emphasis with * is permitted:

+
+
foo*bar*
+.
+<p>foo<em>bar</em></p>
+ +
+
+
5*6*78
+.
+<p>5<em>6</em>78</p>
+ +
+

Rule 2:

+
+
_foo bar_
+.
+<p><em>foo bar</em></p>
+ +
+

This is not emphasis, because the opening _ is followed by +whitespace:

+
+
_ foo bar_
+.
+<p>_ foo bar_</p>
+ +
+

This is not emphasis, because the opening _ is preceded +by an alphanumeric and followed by punctuation:

+
+
a_"foo"_
+.
+<p>a_&quot;foo&quot;_</p>
+ +
+

Emphasis with _ is not allowed inside words:

+
+
foo_bar_
+.
+<p>foo_bar_</p>
+ +
+
+
5_6_78
+.
+<p>5_6_78</p>
+ +
+
+
ĐżŃ€ĐžŃŃ‚Đ°ĐœŃĐŒ_ŃŃ‚Ń€Đ”ĐŒŃŃ‚ŃŃ_
+.
+<p>ĐżŃ€ĐžŃŃ‚Đ°ĐœŃĐŒ_ŃŃ‚Ń€Đ”ĐŒŃŃ‚ŃŃ_</p>
+ +
+

Here _ does not generate emphasis, because the first delimiter run +is right-flanking and the second left-flanking:

+
+
aa_"bb"_cc
+.
+<p>aa_&quot;bb&quot;_cc</p>
+ +
+

This is emphasis, even though the opening delimiter is +both left- and right-flanking, because it is preceded by +punctuation:

+
+
foo-_(bar)_
+.
+<p>foo-<em>(bar)</em></p>
+ +
+

Rule 3:

+

This is not emphasis, because the closing delimiter does +not match the opening delimiter:

+
+
_foo*
+.
+<p>_foo*</p>
+ +
+

This is not emphasis, because the closing * is preceded by +whitespace:

+
+
*foo bar *
+.
+<p>*foo bar *</p>
+ +
+

A newline also counts as whitespace:

+
+
*foo bar
+*
+.
+<p>*foo bar
+*</p>
+ +
+

This is not emphasis, because the second * is +preceded by punctuation and followed by an alphanumeric +(hence it is not part of a [right-flanking delimiter run]:

+
+
*(*foo)
+.
+<p>*(*foo)</p>
+ +
+

The point of this restriction is more easily appreciated +with this example:

+
+
*(*foo*)*
+.
+<p><em>(<em>foo</em>)</em></p>
+ +
+

Intraword emphasis with * is allowed:

+
+
*foo*bar
+.
+<p><em>foo</em>bar</p>
+ +
+

Rule 4:

+

This is not emphasis, because the closing _ is preceded by +whitespace:

+
+
_foo bar _
+.
+<p>_foo bar _</p>
+ +
+

This is not emphasis, because the second _ is +preceded by punctuation and followed by an alphanumeric:

+
+
_(_foo)
+.
+<p>_(_foo)</p>
+ +
+

This is emphasis within emphasis:

+
+
_(_foo_)_
+.
+<p><em>(<em>foo</em>)</em></p>
+ +
+

Intraword emphasis is disallowed for _:

+
+
_foo_bar
+.
+<p>_foo_bar</p>
+ +
+
+
_ĐżŃ€ĐžŃŃ‚Đ°ĐœŃĐŒ_ŃŃ‚Ń€Đ”ĐŒŃŃ‚ŃŃ
+.
+<p>_ĐżŃ€ĐžŃŃ‚Đ°ĐœŃĐŒ_ŃŃ‚Ń€Đ”ĐŒŃŃ‚ŃŃ</p>
+ +
+
+
_foo_bar_baz_
+.
+<p><em>foo_bar_baz</em></p>
+ +
+

This is emphasis, even though the closing delimiter is +both left- and right-flanking, because it is followed by +punctuation:

+
+
_(bar)_.
+.
+<p><em>(bar)</em>.</p>
+ +
+

Rule 5:

+
+
**foo bar**
+.
+<p><strong>foo bar</strong></p>
+ +
+

This is not strong emphasis, because the opening delimiter is +followed by whitespace:

+
+
** foo bar**
+.
+<p>** foo bar**</p>
+ +
+

This is not strong emphasis, because the opening ** is preceded +by an alphanumeric and followed by punctuation, and hence +not part of a [left-flanking delimiter run]:

+
+
a**"foo"**
+.
+<p>a**&quot;foo&quot;**</p>
+ +
+

Intraword strong emphasis with ** is permitted:

+
+
foo**bar**
+.
+<p>foo<strong>bar</strong></p>
+ +
+

Rule 6:

+
+
__foo bar__
+.
+<p><strong>foo bar</strong></p>
+ +
+

This is not strong emphasis, because the opening delimiter is +followed by whitespace:

+
+
__ foo bar__
+.
+<p>__ foo bar__</p>
+ +
+

A newline counts as whitespace:

+
+
__
+foo bar__
+.
+<p>__
+foo bar__</p>
+ +
+

This is not strong emphasis, because the opening __ is preceded +by an alphanumeric and followed by punctuation:

+
+
a__"foo"__
+.
+<p>a__&quot;foo&quot;__</p>
+ +
+

Intraword strong emphasis is forbidden with __:

+
+
foo__bar__
+.
+<p>foo__bar__</p>
+ +
+
+
5__6__78
+.
+<p>5__6__78</p>
+ +
+
+
ĐżŃ€ĐžŃŃ‚Đ°ĐœŃĐŒ__ŃŃ‚Ń€Đ”ĐŒŃŃ‚ŃŃ__
+.
+<p>ĐżŃ€ĐžŃŃ‚Đ°ĐœŃĐŒ__ŃŃ‚Ń€Đ”ĐŒŃŃ‚ŃŃ__</p>
+ +
+
+
__foo, __bar__, baz__
+.
+<p><strong>foo, <strong>bar</strong>, baz</strong></p>
+ +
+

This is strong emphasis, even though the opening delimiter is +both left- and right-flanking, because it is preceded by +punctuation:

+
+
foo-__(bar)__
+.
+<p>foo-<strong>(bar)</strong></p>
+ +
+

Rule 7:

+

This is not strong emphasis, because the closing delimiter is preceded +by whitespace:

+
+
**foo bar **
+.
+<p>**foo bar **</p>
+ +
+

(Nor can it be interpreted as an emphasized *foo bar *, because of +Rule 11.)

+

This is not strong emphasis, because the second ** is +preceded by punctuation and followed by an alphanumeric:

+
+
**(**foo)
+.
+<p>**(**foo)</p>
+ +
+

The point of this restriction is more easily appreciated +with these examples:

+
+
*(**foo**)*
+.
+<p><em>(<strong>foo</strong>)</em></p>
+ +
+
+
**Gomphocarpus (*Gomphocarpus physocarpus*, syn.
+*Asclepias physocarpa*)**
+.
+<p><strong>Gomphocarpus (<em>Gomphocarpus physocarpus</em>, syn.
+<em>Asclepias physocarpa</em>)</strong></p>
+ +
+
+
**foo "*bar*" foo**
+.
+<p><strong>foo &quot;<em>bar</em>&quot; foo</strong></p>
+ +
+

Intraword emphasis:

+
+
**foo**bar
+.
+<p><strong>foo</strong>bar</p>
+ +
+

Rule 8:

+

This is not strong emphasis, because the closing delimiter is +preceded by whitespace:

+
+
__foo bar __
+.
+<p>__foo bar __</p>
+ +
+

This is not strong emphasis, because the second __ is +preceded by punctuation and followed by an alphanumeric:

+
+
__(__foo)
+.
+<p>__(__foo)</p>
+ +
+

The point of this restriction is more easily appreciated +with this example:

+
+
_(__foo__)_
+.
+<p><em>(<strong>foo</strong>)</em></p>
+ +
+

Intraword strong emphasis is forbidden with __:

+
+
__foo__bar
+.
+<p>__foo__bar</p>
+ +
+
+
__ĐżŃ€ĐžŃŃ‚Đ°ĐœŃĐŒ__ŃŃ‚Ń€Đ”ĐŒŃŃ‚ŃŃ
+.
+<p>__ĐżŃ€ĐžŃŃ‚Đ°ĐœŃĐŒ__ŃŃ‚Ń€Đ”ĐŒŃŃ‚ŃŃ</p>
+ +
+
+
__foo__bar__baz__
+.
+<p><strong>foo__bar__baz</strong></p>
+ +
+

This is strong emphasis, even though the closing delimiter is +both left- and right-flanking, because it is followed by +punctuation:

+
+
__(bar)__.
+.
+<p><strong>(bar)</strong>.</p>
+ +
+

Rule 9:

+

Any nonempty sequence of inline elements can be the contents of an +emphasized span.

+
+
*foo [bar](/url)*
+.
+<p><em>foo <a href="/url">bar</a></em></p>
+ +
+
+
*foo
+bar*
+.
+<p><em>foo
+bar</em></p>
+ +
+

In particular, emphasis and strong emphasis can be nested +inside emphasis:

+
+
_foo __bar__ baz_
+.
+<p><em>foo <strong>bar</strong> baz</em></p>
+ +
+
+
_foo _bar_ baz_
+.
+<p><em>foo <em>bar</em> baz</em></p>
+ +
+
+
__foo_ bar_
+.
+<p><em><em>foo</em> bar</em></p>
+ +
+
+
*foo *bar**
+.
+<p><em>foo <em>bar</em></em></p>
+ +
+
+
*foo **bar** baz*
+.
+<p><em>foo <strong>bar</strong> baz</em></p>
+ +
+
+
*foo**bar**baz*
+.
+<p><em>foo<strong>bar</strong>baz</em></p>
+ +
+

Note that in the preceding case, the interpretation

+
+
<p><em>foo</em><em>bar<em></em>baz</em></p>
+ +
+

is precluded by the condition that a delimiter that +can both open and close (like the * after foo) +cannot form emphasis if the sum of the lengths of +the delimiter runs containing the opening and +closing delimiters is a multiple of 3 unless +both lengths are multiples of 3.

+

For the same reason, we don't get two consecutive +emphasis sections in this example:

+
+
*foo**bar*
+.
+<p><em>foo**bar</em></p>
+ +
+

The same condition ensures that the following +cases are all strong emphasis nested inside +emphasis, even when the interior spaces are +omitted:

+
+
***foo** bar*
+.
+<p><em><strong>foo</strong> bar</em></p>
+ +
+
+
*foo **bar***
+.
+<p><em>foo <strong>bar</strong></em></p>
+ +
+
+
*foo**bar***
+.
+<p><em>foo<strong>bar</strong></em></p>
+ +
+

When the lengths of the interior closing and opening +delimiter runs are both multiples of 3, though, +they can match to create emphasis:

+
+
foo***bar***baz
+.
+<p>foo<em><strong>bar</strong></em>baz</p>
+ +
+
+
foo******bar*********baz
+.
+<p>foo<strong><strong><strong>bar</strong></strong></strong>***baz</p>
+ +
+

Indefinite levels of nesting are possible:

+
+
*foo **bar *baz* bim** bop*
+.
+<p><em>foo <strong>bar <em>baz</em> bim</strong> bop</em></p>
+ +
+
+
*foo [*bar*](/url)*
+.
+<p><em>foo <a href="/url"><em>bar</em></a></em></p>
+ +
+

There can be no empty emphasis or strong emphasis:

+
+
** is not an empty emphasis
+.
+<p>** is not an empty emphasis</p>
+ +
+
+
**** is not an empty strong emphasis
+.
+<p>**** is not an empty strong emphasis</p>
+ +
+

Rule 10:

+

Any nonempty sequence of inline elements can be the contents of an +strongly emphasized span.

+
+
**foo [bar](/url)**
+.
+<p><strong>foo <a href="/url">bar</a></strong></p>
+ +
+
+
**foo
+bar**
+.
+<p><strong>foo
+bar</strong></p>
+ +
+

In particular, emphasis and strong emphasis can be nested +inside strong emphasis:

+
+
__foo _bar_ baz__
+.
+<p><strong>foo <em>bar</em> baz</strong></p>
+ +
+
+
__foo __bar__ baz__
+.
+<p><strong>foo <strong>bar</strong> baz</strong></p>
+ +
+
+
____foo__ bar__
+.
+<p><strong><strong>foo</strong> bar</strong></p>
+ +
+
+
**foo **bar****
+.
+<p><strong>foo <strong>bar</strong></strong></p>
+ +
+
+
**foo *bar* baz**
+.
+<p><strong>foo <em>bar</em> baz</strong></p>
+ +
+
+
**foo*bar*baz**
+.
+<p><strong>foo<em>bar</em>baz</strong></p>
+ +
+
+
***foo* bar**
+.
+<p><strong><em>foo</em> bar</strong></p>
+ +
+
+
**foo *bar***
+.
+<p><strong>foo <em>bar</em></strong></p>
+ +
+

Indefinite levels of nesting are possible:

+
+
**foo *bar **baz**
+bim* bop**
+.
+<p><strong>foo <em>bar <strong>baz</strong>
+bim</em> bop</strong></p>
+ +
+
+
**foo [*bar*](/url)**
+.
+<p><strong>foo <a href="/url"><em>bar</em></a></strong></p>
+ +
+

There can be no empty emphasis or strong emphasis:

+
+
__ is not an empty emphasis
+.
+<p>__ is not an empty emphasis</p>
+ +
+
+
____ is not an empty strong emphasis
+.
+<p>____ is not an empty strong emphasis</p>
+ +
+

Rule 11:

+
+
foo ***
+.
+<p>foo ***</p>
+ +
+
+
foo *\**
+.
+<p>foo <em>*</em></p>
+ +
+
+
foo *_*
+.
+<p>foo <em>_</em></p>
+ +
+
+
foo *****
+.
+<p>foo *****</p>
+ +
+
+
foo **\***
+.
+<p>foo <strong>*</strong></p>
+ +
+
+
foo **_**
+.
+<p>foo <strong>_</strong></p>
+ +
+

Note that when delimiters do not match evenly, Rule 11 determines +that the excess literal * characters will appear outside of the +emphasis, rather than inside it:

+
+
**foo*
+.
+<p>*<em>foo</em></p>
+ +
+
+
*foo**
+.
+<p><em>foo</em>*</p>
+ +
+
+
***foo**
+.
+<p>*<strong>foo</strong></p>
+ +
+
+
****foo*
+.
+<p>***<em>foo</em></p>
+ +
+
+
**foo***
+.
+<p><strong>foo</strong>*</p>
+ +
+
+
*foo****
+.
+<p><em>foo</em>***</p>
+ +
+

Rule 12:

+
+
foo ___
+.
+<p>foo ___</p>
+ +
+
+
foo _\__
+.
+<p>foo <em>_</em></p>
+ +
+
+
foo _*_
+.
+<p>foo <em>*</em></p>
+ +
+
+
foo _____
+.
+<p>foo _____</p>
+ +
+
+
foo __\___
+.
+<p>foo <strong>_</strong></p>
+ +
+
+
foo __*__
+.
+<p>foo <strong>*</strong></p>
+ +
+
+
__foo_
+.
+<p>_<em>foo</em></p>
+ +
+

Note that when delimiters do not match evenly, Rule 12 determines +that the excess literal _ characters will appear outside of the +emphasis, rather than inside it:

+
+
_foo__
+.
+<p><em>foo</em>_</p>
+ +
+
+
___foo__
+.
+<p>_<strong>foo</strong></p>
+ +
+
+
____foo_
+.
+<p>___<em>foo</em></p>
+ +
+
+
__foo___
+.
+<p><strong>foo</strong>_</p>
+ +
+
+
_foo____
+.
+<p><em>foo</em>___</p>
+ +
+

Rule 13 implies that if you want emphasis nested directly inside +emphasis, you must use different delimiters:

+
+
**foo**
+.
+<p><strong>foo</strong></p>
+ +
+
+
*_foo_*
+.
+<p><em><em>foo</em></em></p>
+ +
+
+
__foo__
+.
+<p><strong>foo</strong></p>
+ +
+
+
_*foo*_
+.
+<p><em><em>foo</em></em></p>
+ +
+

However, strong emphasis within strong emphasis is possible without +switching delimiters:

+
+
****foo****
+.
+<p><strong><strong>foo</strong></strong></p>
+ +
+
+
____foo____
+.
+<p><strong><strong>foo</strong></strong></p>
+ +
+

Rule 13 can be applied to arbitrarily long sequences of +delimiters:

+
+
******foo******
+.
+<p><strong><strong><strong>foo</strong></strong></strong></p>
+ +
+

Rule 14:

+
+
***foo***
+.
+<p><em><strong>foo</strong></em></p>
+ +
+
+
_____foo_____
+.
+<p><em><strong><strong>foo</strong></strong></em></p>
+ +
+

Rule 15:

+
+
*foo _bar* baz_
+.
+<p><em>foo _bar</em> baz_</p>
+ +
+
+
*foo __bar *baz bim__ bam*
+.
+<p><em>foo <strong>bar *baz bim</strong> bam</em></p>
+ +
+

Rule 16:

+
+
**foo **bar baz**
+.
+<p>**foo <strong>bar baz</strong></p>
+ +
+
+
*foo *bar baz*
+.
+<p>*foo <em>bar baz</em></p>
+ +
+

Rule 17:

+
+
*[bar*](/url)
+.
+<p>*<a href="/url">bar*</a></p>
+ +
+
+
_foo [bar_](/url)
+.
+<p>_foo <a href="/url">bar_</a></p>
+ +
+
+
*<img src="foo" title="*"/>
+.
+<p>*<img src="foo" title="*"/></p>
+ +
+
+
**<a href="**">
+.
+<p>**<a href="**"></p>
+ +
+
+
__<a href="__">
+.
+<p>__<a href="__"></p>
+ +
+
+
*a `*`*
+.
+<p><em>a <code>*</code></em></p>
+ +
+
+
_a `_`_
+.
+<p><em>a <code>_</code></em></p>
+ +
+
+
**a<http://foo.bar/?q=**>
+.
+<p>**a<a href="http://foo.bar/?q=**">http://foo.bar/?q=**</a></p>
+ +
+
+
__a<http://foo.bar/?q=__>
+.
+<p>__a<a href="http://foo.bar/?q=__">http://foo.bar/?q=__</a></p>
+ +
+
+

+Strikethrough (extension)

+

GFM enables the strikethrough extension, where an additional emphasis type is +available.

+

Strikethrough text is any text wrapped in two tildes (~).

+
+
~~Hi~~ Hello, world!
+.
+<p><del>Hi</del> Hello, world!</p>
+ +
+

As with regular emphasis delimiters, a new paragraph will cause strikethrough +parsing to cease:

+
+
This ~~has a
+
+new paragraph~~.
+.
+<p>This ~~has a</p>
+<p>new paragraph~~.</p>
+ +
+
+

+Links

+

A link contains [link text] (the visible text), a [link destination] +(the URI that is the link destination), and optionally a [link title]. +There are two basic kinds of links in Markdown. In [inline links] the +destination and title are given immediately after the link text. In +[reference links] the destination and title are defined elsewhere in +the document.

+

A link text consists of a sequence of zero or more +inline elements enclosed by square brackets ([ and ]). The +following rules apply:

+ +

A link destination consists of either

+ +

A link title consists of either

+ +

Although [link titles] may span multiple lines, they may not contain +a [blank line].

+

An inline link consists of a [link text] followed immediately +by a left parenthesis (, optional [whitespace], an optional +[link destination], an optional [link title] separated from the link +destination by [whitespace], optional [whitespace], and a right +parenthesis ). The link's text consists of the inlines contained +in the [link text] (excluding the enclosing square brackets). +The link's URI consists of the link destination, excluding enclosing +<...> if present, with backslash-escapes in effect as described +above. The link's title consists of the link title, excluding its +enclosing delimiters, with backslash-escapes in effect as described +above.

+

Here is a simple inline link:

+
+
[link](/uri "title")
+.
+<p><a href="/uri" title="title">link</a></p>
+ +
+

The title may be omitted:

+
+
[link](/uri)
+.
+<p><a href="/uri">link</a></p>
+ +
+

Both the title and the destination may be omitted:

+
+
[link]()
+.
+<p><a href="">link</a></p>
+ +
+
+
[link](<>)
+.
+<p><a href="">link</a></p>
+ +
+

The destination can only contain spaces if it is +enclosed in pointy brackets:

+
+
[link](/my uri)
+.
+<p>[link](/my uri)</p>
+ +
+
+
[link](</my uri>)
+.
+<p><a href="/my%20uri">link</a></p>
+ +
+

The destination cannot contain line breaks, +even if enclosed in pointy brackets:

+
+
[link](foo
+bar)
+.
+<p>[link](foo
+bar)</p>
+ +
+
+
[link](<foo
+bar>)
+.
+<p>[link](<foo
+bar>)</p>
+ +
+

The destination can contain ) if it is enclosed +in pointy brackets:

+
+
[a](<b)c>)
+.
+<p><a href="b)c">a</a></p>
+ +
+

Pointy brackets that enclose links must be unescaped:

+
+
[link](<foo\>)
+.
+<p>[link](&lt;foo&gt;)</p>
+ +
+

These are not links, because the opening pointy bracket +is not matched properly:

+
+
[a](<b)c
+[a](<b)c>
+[a](<b>c)
+.
+<p>[a](&lt;b)c
+[a](&lt;b)c&gt;
+[a](<b>c)</p>
+ +
+

Parentheses inside the link destination may be escaped:

+
+
[link](\(foo\))
+.
+<p><a href="(foo)">link</a></p>
+ +
+

Any number of parentheses are allowed without escaping, as long as they are +balanced:

+
+
[link](foo(and(bar)))
+.
+<p><a href="foo(and(bar))">link</a></p>
+ +
+

However, if you have unbalanced parentheses, you need to escape or use the +<...> form:

+
+
[link](foo\(and\(bar\))
+.
+<p><a href="foo(and(bar)">link</a></p>
+ +
+
+
[link](<foo(and(bar)>)
+.
+<p><a href="foo(and(bar)">link</a></p>
+ +
+

Parentheses and other symbols can also be escaped, as usual +in Markdown:

+
+
[link](foo\)\:)
+.
+<p><a href="foo):">link</a></p>
+ +
+

A link can contain fragment identifiers and queries:

+
+
[link](#fragment)
+
+[link](http://example.com#fragment)
+
+[link](http://example.com?foo=3#frag)
+.
+<p><a href="#fragment">link</a></p>
+<p><a href="http://example.com#fragment">link</a></p>
+<p><a href="http://example.com?foo=3#frag">link</a></p>
+ +
+

Note that a backslash before a non-escapable character is +just a backslash:

+
+
[link](foo\bar)
+.
+<p><a href="foo%5Cbar">link</a></p>
+ +
+

URL-escaping should be left alone inside the destination, as all +URL-escaped characters are also valid URL characters. Entity and +numerical character references in the destination will be parsed +into the corresponding Unicode code points, as usual. These may +be optionally URL-escaped when written as HTML, but this spec +does not enforce any particular policy for rendering URLs in +HTML or other formats. Renderers may make different decisions +about how to escape or normalize URLs in the output.

+
+
[link](foo%20b&auml;)
+.
+<p><a href="foo%20b%C3%A4">link</a></p>
+ +
+

Note that, because titles can often be parsed as destinations, +if you try to omit the destination and keep the title, you'll +get unexpected results:

+
+
[link]("title")
+.
+<p><a href="%22title%22">link</a></p>
+ +
+

Titles may be in single quotes, double quotes, or parentheses:

+
+
[link](/url "title")
+[link](/url 'title')
+[link](/url (title))
+.
+<p><a href="/url" title="title">link</a>
+<a href="/url" title="title">link</a>
+<a href="/url" title="title">link</a></p>
+ +
+

Backslash escapes and entity and numeric character references +may be used in titles:

+
+
[link](/url "title \"&quot;")
+.
+<p><a href="/url" title="title &quot;&quot;">link</a></p>
+ +
+

Titles must be separated from the link using a [whitespace]. +Other [Unicode whitespace] like non-breaking space doesn't work.

+
+
[link](/url "title")
+.
+<p><a href="/url%C2%A0%22title%22">link</a></p>
+ +
+

Nested balanced quotes are not allowed without escaping:

+
+
[link](/url "title "and" title")
+.
+<p>[link](/url &quot;title &quot;and&quot; title&quot;)</p>
+ +
+

But it is easy to work around this by using a different quote type:

+
+
[link](/url 'title "and" title')
+.
+<p><a href="/url" title="title &quot;and&quot; title">link</a></p>
+ +
+

(Note: Markdown.pl did allow double quotes inside a double-quoted +title, and its test suite included a test demonstrating this. +But it is hard to see a good rationale for the extra complexity this +brings, since there are already many ways---backslash escaping, +entity and numeric character references, or using a different +quote type for the enclosing title---to write titles containing +double quotes. Markdown.pl's handling of titles has a number +of other strange features. For example, it allows single-quoted +titles in inline links, but not reference links. And, in +reference links but not inline links, it allows a title to begin +with " and end with ). Markdown.pl 1.0.1 even allows +titles with no closing quotation mark, though 1.0.2b8 does not. +It seems preferable to adopt a simple, rational rule that works +the same way in inline links and link reference definitions.)

+

[Whitespace] is allowed around the destination and title:

+
+
[link](   /uri
+  "title"  )
+.
+<p><a href="/uri" title="title">link</a></p>
+ +
+

But it is not allowed between the link text and the +following parenthesis:

+
+
[link] (/uri)
+.
+<p>[link] (/uri)</p>
+ +
+

The link text may contain balanced brackets, but not unbalanced ones, +unless they are escaped:

+
+
[link [foo [bar]]](/uri)
+.
+<p><a href="/uri">link [foo [bar]]</a></p>
+ +
+
+
[link] bar](/uri)
+.
+<p>[link] bar](/uri)</p>
+ +
+
+
[link [bar](/uri)
+.
+<p>[link <a href="/uri">bar</a></p>
+ +
+
+
[link \[bar](/uri)
+.
+<p><a href="/uri">link [bar</a></p>
+ +
+

The link text may contain inline content:

+
+
[link *foo **bar** `#`*](/uri)
+.
+<p><a href="/uri">link <em>foo <strong>bar</strong> <code>#</code></em></a></p>
+ +
+
+
[![moon](moon.jpg)](/uri)
+.
+<p><a href="/uri"><img src="moon.jpg" alt="moon" /></a></p>
+ +
+

However, links may not contain other links, at any level of nesting.

+
+
[foo [bar](/uri)](/uri)
+.
+<p>[foo <a href="/uri">bar</a>](/uri)</p>
+ +
+
+
[foo *[bar [baz](/uri)](/uri)*](/uri)
+.
+<p>[foo <em>[bar <a href="/uri">baz</a>](/uri)</em>](/uri)</p>
+ +
+
+
![[[foo](uri1)](uri2)](uri3)
+.
+<p><img src="uri3" alt="[foo](uri2)" /></p>
+ +
+

These cases illustrate the precedence of link text grouping over +emphasis grouping:

+
+
*[foo*](/uri)
+.
+<p>*<a href="/uri">foo*</a></p>
+ +
+
+
[foo *bar](baz*)
+.
+<p><a href="baz*">foo *bar</a></p>
+ +
+

Note that brackets that aren't part of links do not take +precedence:

+
+
*foo [bar* baz]
+.
+<p><em>foo [bar</em> baz]</p>
+ +
+

These cases illustrate the precedence of HTML tags, code spans, +and autolinks over link grouping:

+
+
[foo <bar attr="](baz)">
+.
+<p>[foo <bar attr="](baz)"></p>
+ +
+
+
[foo`](/uri)`
+.
+<p>[foo<code>](/uri)</code></p>
+ +
+
+
[foo<http://example.com/?search=](uri)>
+.
+<p>[foo<a href="http://example.com/?search=%5D(uri)">http://example.com/?search=](uri)</a></p>
+ +
+

There are three kinds of reference links: +full, collapsed, +and shortcut.

+

A full reference link +consists of a [link text] immediately followed by a [link label] +that [matches] a [link reference definition] elsewhere in the document.

+

A link label begins with a left bracket ([) and ends +with the first right bracket (]) that is not backslash-escaped. +Between these brackets there must be at least one [non-whitespace character]. +Unescaped square bracket characters are not allowed inside the +opening and closing square brackets of [link labels]. A link +label can have at most 999 characters inside the square +brackets.

+

One label matches +another just in case their normalized forms are equal. To normalize a +label, strip off the opening and closing brackets, +perform the Unicode case fold, strip leading and trailing +[whitespace] and collapse consecutive internal +[whitespace] to a single space. If there are multiple +matching reference link definitions, the one that comes first in the +document is used. (It is desirable in such cases to emit a warning.)

+

The contents of the first link label are parsed as inlines, which are +used as the link's text. The link's URI and title are provided by the +matching [link reference definition].

+

Here is a simple example:

+
+
[foo][bar]
+
+[bar]: /url "title"
+.
+<p><a href="/url" title="title">foo</a></p>
+ +
+

The rules for the [link text] are the same as with +[inline links]. Thus:

+

The link text may contain balanced brackets, but not unbalanced ones, +unless they are escaped:

+
+
[link [foo [bar]]][ref]
+
+[ref]: /uri
+.
+<p><a href="/uri">link [foo [bar]]</a></p>
+ +
+
+
[link \[bar][ref]
+
+[ref]: /uri
+.
+<p><a href="/uri">link [bar</a></p>
+ +
+

The link text may contain inline content:

+
+
[link *foo **bar** `#`*][ref]
+
+[ref]: /uri
+.
+<p><a href="/uri">link <em>foo <strong>bar</strong> <code>#</code></em></a></p>
+ +
+
+
[![moon](moon.jpg)][ref]
+
+[ref]: /uri
+.
+<p><a href="/uri"><img src="moon.jpg" alt="moon" /></a></p>
+ +
+

However, links may not contain other links, at any level of nesting.

+
+
[foo [bar](/uri)][ref]
+
+[ref]: /uri
+.
+<p>[foo <a href="/uri">bar</a>]<a href="/uri">ref</a></p>
+ +
+
+
[foo *bar [baz][ref]*][ref]
+
+[ref]: /uri
+.
+<p>[foo <em>bar <a href="/uri">baz</a></em>]<a href="/uri">ref</a></p>
+ +
+

(In the examples above, we have two [shortcut reference links] +instead of one [full reference link].)

+

The following cases illustrate the precedence of link text grouping over +emphasis grouping:

+
+
*[foo*][ref]
+
+[ref]: /uri
+.
+<p>*<a href="/uri">foo*</a></p>
+ +
+
+
[foo *bar][ref]
+
+[ref]: /uri
+.
+<p><a href="/uri">foo *bar</a></p>
+ +
+

These cases illustrate the precedence of HTML tags, code spans, +and autolinks over link grouping:

+
+
[foo <bar attr="][ref]">
+
+[ref]: /uri
+.
+<p>[foo <bar attr="][ref]"></p>
+ +
+
+
[foo`][ref]`
+
+[ref]: /uri
+.
+<p>[foo<code>][ref]</code></p>
+ +
+
+
[foo<http://example.com/?search=][ref]>
+
+[ref]: /uri
+.
+<p>[foo<a href="http://example.com/?search=%5D%5Bref%5D">http://example.com/?search=][ref]</a></p>
+ +
+

Matching is case-insensitive:

+
+
[foo][BaR]
+
+[bar]: /url "title"
+.
+<p><a href="/url" title="title">foo</a></p>
+ +
+

Unicode case fold is used:

+
+
[ĐąĐŸĐ»ĐżĐŸĐč][ĐąĐŸĐ»ĐżĐŸĐč] is a Russian word.
+
+[бОЛПОЙ]: /url
+.
+<p><a href="/url">ĐąĐŸĐ»ĐżĐŸĐč</a> is a Russian word.</p>
+ +
+

Consecutive internal [whitespace] is treated as one space for +purposes of determining matching:

+
+
[Foo
+  bar]: /url
+
+[Baz][Foo bar]
+.
+<p><a href="/url">Baz</a></p>
+ +
+

No [whitespace] is allowed between the [link text] and the +[link label]:

+
+
[foo] [bar]
+
+[bar]: /url "title"
+.
+<p>[foo] <a href="/url" title="title">bar</a></p>
+ +
+
+
[foo]
+[bar]
+
+[bar]: /url "title"
+.
+<p>[foo]
+<a href="/url" title="title">bar</a></p>
+ +
+

This is a departure from John Gruber's original Markdown syntax +description, which explicitly allows whitespace between the link +text and the link label. It brings reference links in line with +[inline links], which (according to both original Markdown and +this spec) cannot have whitespace after the link text. More +importantly, it prevents inadvertent capture of consecutive +[shortcut reference links]. If whitespace is allowed between the +link text and the link label, then in the following we will have +a single reference link, not two shortcut reference links, as +intended:

+
+
[foo]
+[bar]
+
+[foo]: /url1
+[bar]: /url2
+ +
+

(Note that [shortcut reference links] were introduced by Gruber +himself in a beta version of Markdown.pl, but never included +in the official syntax description. Without shortcut reference +links, it is harmless to allow space between the link text and +link label; but once shortcut references are introduced, it is +too dangerous to allow this, as it frequently leads to +unintended results.)

+

When there are multiple matching [link reference definitions], +the first is used:

+
+
[foo]: /url1
+
+[foo]: /url2
+
+[bar][foo]
+.
+<p><a href="/url1">bar</a></p>
+ +
+

Note that matching is performed on normalized strings, not parsed +inline content. So the following does not match, even though the +labels define equivalent inline content:

+
+
[bar][foo\!]
+
+[foo!]: /url
+.
+<p>[bar][foo!]</p>
+ +
+

[Link labels] cannot contain brackets, unless they are +backslash-escaped:

+
+
[foo][ref[]
+
+[ref[]: /uri
+.
+<p>[foo][ref[]</p>
+<p>[ref[]: /uri</p>
+ +
+
+
[foo][ref[bar]]
+
+[ref[bar]]: /uri
+.
+<p>[foo][ref[bar]]</p>
+<p>[ref[bar]]: /uri</p>
+ +
+
+
[[[foo]]]
+
+[[[foo]]]: /url
+.
+<p>[[[foo]]]</p>
+<p>[[[foo]]]: /url</p>
+ +
+
+
[foo][ref\[]
+
+[ref\[]: /uri
+.
+<p><a href="/uri">foo</a></p>
+ +
+

Note that in this example ] is not backslash-escaped:

+
+
[bar\\]: /uri
+
+[bar\\]
+.
+<p><a href="/uri">bar\</a></p>
+ +
+

A [link label] must contain at least one [non-whitespace character]:

+
+
[]
+
+[]: /uri
+.
+<p>[]</p>
+<p>[]: /uri</p>
+ +
+
+
[
+ ]
+
+[
+ ]: /uri
+.
+<p>[
+]</p>
+<p>[
+]: /uri</p>
+ +
+

A collapsed reference link +consists of a [link label] that [matches] a +[link reference definition] elsewhere in the +document, followed by the string []. +The contents of the first link label are parsed as inlines, +which are used as the link's text. The link's URI and title are +provided by the matching reference link definition. Thus, +[foo][] is equivalent to [foo][foo].

+
+
[foo][]
+
+[foo]: /url "title"
+.
+<p><a href="/url" title="title">foo</a></p>
+ +
+
+
[*foo* bar][]
+
+[*foo* bar]: /url "title"
+.
+<p><a href="/url" title="title"><em>foo</em> bar</a></p>
+ +
+

The link labels are case-insensitive:

+
+
[Foo][]
+
+[foo]: /url "title"
+.
+<p><a href="/url" title="title">Foo</a></p>
+ +
+

As with full reference links, [whitespace] is not +allowed between the two sets of brackets:

+
+
[foo] 
+[]
+
+[foo]: /url "title"
+.
+<p><a href="/url" title="title">foo</a>
+[]</p>
+ +
+

A shortcut reference link +consists of a [link label] that [matches] a +[link reference definition] elsewhere in the +document and is not followed by [] or a link label. +The contents of the first link label are parsed as inlines, +which are used as the link's text. The link's URI and title +are provided by the matching link reference definition. +Thus, [foo] is equivalent to [foo][].

+
+
[foo]
+
+[foo]: /url "title"
+.
+<p><a href="/url" title="title">foo</a></p>
+ +
+
+
[*foo* bar]
+
+[*foo* bar]: /url "title"
+.
+<p><a href="/url" title="title"><em>foo</em> bar</a></p>
+ +
+
+
[[*foo* bar]]
+
+[*foo* bar]: /url "title"
+.
+<p>[<a href="/url" title="title"><em>foo</em> bar</a>]</p>
+ +
+
+
[[bar [foo]
+
+[foo]: /url
+.
+<p>[[bar <a href="/url">foo</a></p>
+ +
+

The link labels are case-insensitive:

+
+
[Foo]
+
+[foo]: /url "title"
+.
+<p><a href="/url" title="title">Foo</a></p>
+ +
+

A space after the link text should be preserved:

+
+
[foo] bar
+
+[foo]: /url
+.
+<p><a href="/url">foo</a> bar</p>
+ +
+

If you just want bracketed text, you can backslash-escape the +opening bracket to avoid links:

+
+
\[foo]
+
+[foo]: /url "title"
+.
+<p>[foo]</p>
+ +
+

Note that this is a link, because a link label ends with the first +following closing bracket:

+
+
[foo*]: /url
+
+*[foo*]
+.
+<p>*<a href="/url">foo*</a></p>
+ +
+

Full and compact references take precedence over shortcut +references:

+
+
[foo][bar]
+
+[foo]: /url1
+[bar]: /url2
+.
+<p><a href="/url2">foo</a></p>
+ +
+
+
[foo][]
+
+[foo]: /url1
+.
+<p><a href="/url1">foo</a></p>
+ +
+

Inline links also take precedence:

+
+
[foo]()
+
+[foo]: /url1
+.
+<p><a href="">foo</a></p>
+ +
+
+
[foo](not a link)
+
+[foo]: /url1
+.
+<p><a href="/url1">foo</a>(not a link)</p>
+ +
+

In the following case [bar][baz] is parsed as a reference, +[foo] as normal text:

+
+
[foo][bar][baz]
+
+[baz]: /url
+.
+<p>[foo]<a href="/url">bar</a></p>
+ +
+

Here, though, [foo][bar] is parsed as a reference, since +[bar] is defined:

+
+
[foo][bar][baz]
+
+[baz]: /url1
+[bar]: /url2
+.
+<p><a href="/url2">foo</a><a href="/url1">baz</a></p>
+ +
+

Here [foo] is not parsed as a shortcut reference, because it +is followed by a link label (even though [bar] is not defined):

+
+
[foo][bar][baz]
+
+[baz]: /url1
+[foo]: /url2
+.
+<p>[foo]<a href="/url1">bar</a></p>
+ +
+

+Images

+

Syntax for images is like the syntax for links, with one +difference. Instead of [link text], we have an +image description. The rules for this are the +same as for [link text], except that (a) an +image description starts with ![ rather than [, and +(b) an image description may contain links. +An image description has inline elements +as its contents. When an image is rendered to HTML, +this is standardly used as the image's alt attribute.

+
+
![foo](/url "title")
+.
+<p><img src="/url" alt="foo" title="title" /></p>
+ +
+
+
![foo *bar*]
+
+[foo *bar*]: train.jpg "train & tracks"
+.
+<p><img src="train.jpg" alt="foo bar" title="train &amp; tracks" /></p>
+ +
+
+
![foo ![bar](/url)](/url2)
+.
+<p><img src="/url2" alt="foo bar" /></p>
+ +
+
+
![foo [bar](/url)](/url2)
+.
+<p><img src="/url2" alt="foo bar" /></p>
+ +
+

Though this spec is concerned with parsing, not rendering, it is +recommended that in rendering to HTML, only the plain string content +of the [image description] be used. Note that in +the above example, the alt attribute's value is foo bar, not foo [bar](/url) or foo <a href="/url">bar</a>. Only the plain string +content is rendered, without formatting.

+
+
![foo *bar*][]
+
+[foo *bar*]: train.jpg "train & tracks"
+.
+<p><img src="train.jpg" alt="foo bar" title="train &amp; tracks" /></p>
+ +
+
+
![foo *bar*][foobar]
+
+[FOOBAR]: train.jpg "train & tracks"
+.
+<p><img src="train.jpg" alt="foo bar" title="train &amp; tracks" /></p>
+ +
+
+
![foo](train.jpg)
+.
+<p><img src="train.jpg" alt="foo" /></p>
+ +
+
+
My ![foo bar](/path/to/train.jpg  "title"   )
+.
+<p>My <img src="/path/to/train.jpg" alt="foo bar" title="title" /></p>
+ +
+
+
![foo](<url>)
+.
+<p><img src="url" alt="foo" /></p>
+ +
+
+
![](/url)
+.
+<p><img src="/url" alt="" /></p>
+ +
+

Reference-style:

+
+
![foo][bar]
+
+[bar]: /url
+.
+<p><img src="/url" alt="foo" /></p>
+ +
+
+
![foo][bar]
+
+[BAR]: /url
+.
+<p><img src="/url" alt="foo" /></p>
+ +
+

Collapsed:

+
+
![foo][]
+
+[foo]: /url "title"
+.
+<p><img src="/url" alt="foo" title="title" /></p>
+ +
+
+
![*foo* bar][]
+
+[*foo* bar]: /url "title"
+.
+<p><img src="/url" alt="foo bar" title="title" /></p>
+ +
+

The labels are case-insensitive:

+
+
![Foo][]
+
+[foo]: /url "title"
+.
+<p><img src="/url" alt="Foo" title="title" /></p>
+ +
+

As with reference links, [whitespace] is not allowed +between the two sets of brackets:

+
+
![foo] 
+[]
+
+[foo]: /url "title"
+.
+<p><img src="/url" alt="foo" title="title" />
+[]</p>
+ +
+

Shortcut:

+
+
![foo]
+
+[foo]: /url "title"
+.
+<p><img src="/url" alt="foo" title="title" /></p>
+ +
+
+
![*foo* bar]
+
+[*foo* bar]: /url "title"
+.
+<p><img src="/url" alt="foo bar" title="title" /></p>
+ +
+

Note that link labels cannot contain unescaped brackets:

+
+
![[foo]]
+
+[[foo]]: /url "title"
+.
+<p>![[foo]]</p>
+<p>[[foo]]: /url &quot;title&quot;</p>
+ +
+

The link labels are case-insensitive:

+
+
![Foo]
+
+[foo]: /url "title"
+.
+<p><img src="/url" alt="Foo" title="title" /></p>
+ +
+

If you just want a literal ! followed by bracketed text, you can +backslash-escape the opening [:

+
+
!\[foo]
+
+[foo]: /url "title"
+.
+<p>![foo]</p>
+ +
+

If you want a link after a literal !, backslash-escape the +!:

+
+
\![foo]
+
+[foo]: /url "title"
+.
+<p>!<a href="/url" title="title">foo</a></p>
+ +
+

+Autolinks

+

Autolinks are absolute URIs and email addresses inside +< and >. They are parsed as links, with the URL or email address +as the link label.

+

A URI autolink consists of <, followed by an +[absolute URI] followed by >. It is parsed as +a link to the URI, with the URI as the link's label.

+

An absolute URI, +for these purposes, consists of a [scheme] followed by a colon (:) +followed by zero or more characters other than ASCII +[whitespace] and control characters, <, and >. If +the URI includes these characters, they must be percent-encoded +(e.g. %20 for a space).

+

For purposes of this spec, a scheme is any sequence +of 2--32 characters beginning with an ASCII letter and followed +by any combination of ASCII letters, digits, or the symbols plus +("+"), period ("."), or hyphen ("-").

+

Here are some valid autolinks:

+
+
<http://foo.bar.baz>
+.
+<p><a href="http://foo.bar.baz">http://foo.bar.baz</a></p>
+ +
+
+
<http://foo.bar.baz/test?q=hello&id=22&boolean>
+.
+<p><a href="http://foo.bar.baz/test?q=hello&amp;id=22&amp;boolean">http://foo.bar.baz/test?q=hello&amp;id=22&amp;boolean</a></p>
+ +
+
+
<irc://foo.bar:2233/baz>
+.
+<p><a href="irc://foo.bar:2233/baz">irc://foo.bar:2233/baz</a></p>
+ +
+

Uppercase is also fine:

+
+
<MAILTO:FOO@BAR.BAZ>
+.
+<p><a href="MAILTO:FOO@BAR.BAZ">MAILTO:FOO@BAR.BAZ</a></p>
+ +
+

Note that many strings that count as [absolute URIs] for +purposes of this spec are not valid URIs, because their +schemes are not registered or because of other problems +with their syntax:

+
+
<a+b+c:d>
+.
+<p><a href="a+b+c:d">a+b+c:d</a></p>
+ +
+
+
<made-up-scheme://foo,bar>
+.
+<p><a href="made-up-scheme://foo,bar">made-up-scheme://foo,bar</a></p>
+ +
+
+
<http://../>
+.
+<p><a href="http://../">http://../</a></p>
+ +
+
+
<localhost:5001/foo>
+.
+<p><a href="localhost:5001/foo">localhost:5001/foo</a></p>
+ +
+

Spaces are not allowed in autolinks:

+
+
<http://foo.bar/baz bim>
+.
+<p>&lt;http://foo.bar/baz bim&gt;</p>
+ +
+

Backslash-escapes do not work inside autolinks:

+
+
<http://example.com/\[\>
+.
+<p><a href="http://example.com/%5C%5B%5C">http://example.com/\[\</a></p>
+ +
+

An email autolink +consists of <, followed by an [email address], +followed by >. The link's label is the email address, +and the URL is mailto: followed by the email address.

+

An email address, +for these purposes, is anything that matches +the non-normative regex from the HTML5 +spec:

+
+
/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?
+(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/
+ +
+

Examples of email autolinks:

+
+
<foo@bar.example.com>
+.
+<p><a href="mailto:foo@bar.example.com">foo@bar.example.com</a></p>
+ +
+
+
<foo+special@Bar.baz-bar0.com>
+.
+<p><a href="mailto:foo+special@Bar.baz-bar0.com">foo+special@Bar.baz-bar0.com</a></p>
+ +
+

Backslash-escapes do not work inside email autolinks:

+
+
<foo\+@bar.example.com>
+.
+<p>&lt;foo+@bar.example.com&gt;</p>
+ +
+

These are not autolinks:

+
+
<>
+.
+<p>&lt;&gt;</p>
+ +
+
+
< http://foo.bar >
+.
+<p>&lt; http://foo.bar &gt;</p>
+ +
+
+
<m:abc>
+.
+<p>&lt;m:abc&gt;</p>
+ +
+
+
<foo.bar.baz>
+.
+<p>&lt;foo.bar.baz&gt;</p>
+ +
+
+
http://example.com
+.
+<p>http://example.com</p>
+ +
+
+
foo@bar.example.com
+.
+<p>foo@bar.example.com</p>
+ +
+
+

+Autolinks (extension)

+

GFM enables the autolink extension, where autolinks will be recognised in a +greater number of conditions.

+

[Autolink]s can also be constructed without requiring the use of < and to > +to delimit them, although they will be recognized under a smaller set of +circumstances. All such recognized autolinks can only come at the beginning of +a line, after whitespace, or any of the delimiting characters *, _, ~, +and (.

+

An extended www autolink will be recognized +when the text www. is found followed by a [valid domain]. +A valid domain consists of segments +of alphanumeric characters, underscores (_) and hyphens (-) +separated by periods (.). +There must be at least one period, +and no underscores may be present in the last two segments of the domain.

+

The scheme http will be inserted automatically:

+
+
www.commonmark.org
+.
+<p><a href="http://www.commonmark.org">www.commonmark.org</a></p>
+ +
+

After a [valid domain], zero or more non-space non-< characters may follow:

+
+
Visit www.commonmark.org/help for more information.
+.
+<p>Visit <a href="http://www.commonmark.org/help">www.commonmark.org/help</a> for more information.</p>
+ +
+

We then apply extended autolink path validation as follows:

+

Trailing punctuation (specifically, ?, !, ., ,, :, *, _, and ~) +will not be considered part of the autolink, though they may be included in the +interior of the link:

+
+
Visit www.commonmark.org.
+
+Visit www.commonmark.org/a.b.
+.
+<p>Visit <a href="http://www.commonmark.org">www.commonmark.org</a>.</p>
+<p>Visit <a href="http://www.commonmark.org/a.b">www.commonmark.org/a.b</a>.</p>
+ +
+

When an autolink ends in ), we scan the entire autolink for the total number +of parentheses. If there is a greater number of closing parentheses than +opening ones, we don't consider the unmatched trailing parentheses part of the +autolink, in order to facilitate including an autolink inside a parenthesis:

+
+
www.google.com/search?q=Markup+(business)
+
+www.google.com/search?q=Markup+(business)))
+
+(www.google.com/search?q=Markup+(business))
+
+(www.google.com/search?q=Markup+(business)
+.
+<p><a href="http://www.google.com/search?q=Markup+(business)">www.google.com/search?q=Markup+(business)</a></p>
+<p><a href="http://www.google.com/search?q=Markup+(business)">www.google.com/search?q=Markup+(business)</a>))</p>
+<p>(<a href="http://www.google.com/search?q=Markup+(business)">www.google.com/search?q=Markup+(business)</a>)</p>
+<p>(<a href="http://www.google.com/search?q=Markup+(business)">www.google.com/search?q=Markup+(business)</a></p>
+ +
+

This check is only done when the link ends in a closing parentheses ), so if +the only parentheses are in the interior of the autolink, no special rules are +applied:

+
+
www.google.com/search?q=(business))+ok
+.
+<p><a href="http://www.google.com/search?q=(business))+ok">www.google.com/search?q=(business))+ok</a></p>
+ +
+

If an autolink ends in a semicolon (;), we check to see if it appears to +resemble an [entity reference][entity references]; if the preceding text is & +followed by one or more alphanumeric characters. If so, it is excluded from +the autolink:

+
+
www.google.com/search?q=commonmark&hl=en
+
+www.google.com/search?q=commonmark&hl;
+.
+<p><a href="http://www.google.com/search?q=commonmark&amp;hl=en">www.google.com/search?q=commonmark&amp;hl=en</a></p>
+<p><a href="http://www.google.com/search?q=commonmark">www.google.com/search?q=commonmark</a>&amp;hl;</p>
+ +
+

< immediately ends an autolink.

+
+
www.commonmark.org/he<lp
+.
+<p><a href="http://www.commonmark.org/he">www.commonmark.org/he</a>&lt;lp</p>
+ +
+

An extended url autolink will be recognised when one of the schemes +http://, https://, or ftp://, followed by a [valid domain], then zero or +more non-space non-< characters according to +[extended autolink path validation]:

+
+
http://commonmark.org
+
+(Visit https://encrypted.google.com/search?q=Markup+(business))
+
+Anonymous FTP is available at ftp://foo.bar.baz.
+.
+<p><a href="http://commonmark.org">http://commonmark.org</a></p>
+<p>(Visit <a href="https://encrypted.google.com/search?q=Markup+(business)">https://encrypted.google.com/search?q=Markup+(business)</a>)</p>
+<p>Anonymous FTP is available at <a href="ftp://foo.bar.baz">ftp://foo.bar.baz</a>.</p>
+ +
+

An extended email autolink will be recognised when an email address is +recognised within any text node. Email addresses are recognised according to +the following rules:

+ +

The scheme mailto: will automatically be added to the generated link:

+
+
foo@bar.baz
+.
+<p><a href="mailto:foo@bar.baz">foo@bar.baz</a></p>
+ +
+

+ can occur before the @, but not after.

+
+
hello@mail+xyz.example isn't valid, but hello+xyz@mail.example is.
+.
+<p>hello@mail+xyz.example isn't valid, but <a href="mailto:hello+xyz@mail.example">hello+xyz@mail.example</a> is.</p>
+ +
+

., -, and _ can occur on both sides of the @, but only . may occur at +the end of the email address, in which case it will not be considered part of +the address:

+
+
a.b-c_d@a.b
+
+a.b-c_d@a.b.
+
+a.b-c_d@a.b-
+
+a.b-c_d@a.b_
+.
+<p><a href="mailto:a.b-c_d@a.b">a.b-c_d@a.b</a></p>
+<p><a href="mailto:a.b-c_d@a.b">a.b-c_d@a.b</a>.</p>
+<p>a.b-c_d@a.b-</p>
+<p>a.b-c_d@a.b_</p>
+ +
+
+

+Raw HTML

+

Text between < and > that looks like an HTML tag is parsed as a +raw HTML tag and will be rendered in HTML without escaping. +Tag and attribute names are not limited to current HTML tags, +so custom tags (and even, say, DocBook tags) may be used.

+

Here is the grammar for tags:

+

A tag name consists of an ASCII letter +followed by zero or more ASCII letters, digits, or +hyphens (-).

+

An attribute consists of [whitespace], +an [attribute name], and an optional +[attribute value specification].

+

An attribute name +consists of an ASCII letter, _, or :, followed by zero or more ASCII +letters, digits, _, ., :, or -. (Note: This is the XML +specification restricted to ASCII. HTML5 is laxer.)

+

An attribute value specification +consists of optional [whitespace], +a = character, optional [whitespace], and an [attribute +value].

+

An attribute value +consists of an [unquoted attribute value], +a [single-quoted attribute value], or a [double-quoted attribute value].

+

An unquoted attribute value +is a nonempty string of characters not +including [whitespace], ", ', =, <, >, or `.

+

A single-quoted attribute value +consists of ', zero or more +characters not including ', and a final '.

+

A double-quoted attribute value +consists of ", zero or more +characters not including ", and a final ".

+

An open tag consists of a < character, a [tag name], +zero or more [attributes], optional [whitespace], an optional / +character, and a > character.

+

A closing tag consists of the string </, a +[tag name], optional [whitespace], and the character >.

+

An HTML comment consists of <!-- + text + -->, +where text does not start with > or ->, does not end with -, +and does not contain --. (See the +HTML5 spec.)

+

A processing instruction +consists of the string <?, a string +of characters not including the string ?>, and the string +?>.

+

A declaration consists of the +string <!, a name consisting of one or more uppercase ASCII letters, +[whitespace], a string of characters not including the +character >, and the character >.

+

A CDATA section consists of +the string <![CDATA[, a string of characters not including the string +]]>, and the string ]]>.

+

An HTML tag consists of an [open tag], a [closing tag], +an [HTML comment], a [processing instruction], a [declaration], +or a [CDATA section].

+

Here are some simple open tags:

+
+
<a><bab><c2c>
+.
+<p><a><bab><c2c></p>
+ +
+

Empty elements:

+
+
<a/><b2/>
+.
+<p><a/><b2/></p>
+ +
+

[Whitespace] is allowed:

+
+
<a  /><b2
+data="foo" >
+.
+<p><a  /><b2
+data="foo" ></p>
+ +
+

With attributes:

+
+
<a foo="bar" bam = 'baz <em>"</em>'
+_boolean zoop:33=zoop:33 />
+.
+<p><a foo="bar" bam = 'baz <em>"</em>'
+_boolean zoop:33=zoop:33 /></p>
+ +
+

Custom tag names can be used:

+
+
Foo <responsive-image src="foo.jpg" />
+.
+<p>Foo <responsive-image src="foo.jpg" /></p>
+ +
+

Illegal tag names, not parsed as HTML:

+
+
<33> <__>
+.
+<p>&lt;33&gt; &lt;__&gt;</p>
+ +
+

Illegal attribute names:

+
+
<a h*#ref="hi">
+.
+<p>&lt;a h*#ref=&quot;hi&quot;&gt;</p>
+ +
+

Illegal attribute values:

+
+
<a href="hi'> <a href=hi'>
+.
+<p>&lt;a href=&quot;hi'&gt; &lt;a href=hi'&gt;</p>
+ +
+

Illegal [whitespace]:

+
+
< a><
+foo><bar/ >
+<foo bar=baz
+bim!bop />
+.
+<p>&lt; a&gt;&lt;
+foo&gt;&lt;bar/ &gt;
+&lt;foo bar=baz
+bim!bop /&gt;</p>
+ +
+

Missing [whitespace]:

+
+
<a href='bar'title=title>
+.
+<p>&lt;a href='bar'title=title&gt;</p>
+ +
+

Closing tags:

+
+
</a></foo >
+.
+<p></a></foo ></p>
+ +
+

Illegal attributes in closing tag:

+
+
</a href="foo">
+.
+<p>&lt;/a href=&quot;foo&quot;&gt;</p>
+ +
+

Comments:

+
+
foo <!-- this is a
+comment - with hyphen -->
+.
+<p>foo <!-- this is a
+comment - with hyphen --></p>
+ +
+
+
foo <!-- not a comment -- two hyphens -->
+.
+<p>foo &lt;!-- not a comment -- two hyphens --&gt;</p>
+ +
+

Not comments:

+
+
foo <!--> foo -->
+
+foo <!-- foo--->
+.
+<p>foo &lt;!--&gt; foo --&gt;</p>
+<p>foo &lt;!-- foo---&gt;</p>
+ +
+

Processing instructions:

+
+
foo <?php echo $a; ?>
+.
+<p>foo <?php echo $a; ?></p>
+ +
+

Declarations:

+
+
foo <!ELEMENT br EMPTY>
+.
+<p>foo <!ELEMENT br EMPTY></p>
+ +
+

CDATA sections:

+
+
foo <![CDATA[>&<]]>
+.
+<p>foo <![CDATA[>&<]]></p>
+ +
+

Entity and numeric character references are preserved in HTML +attributes:

+
+
foo <a href="&ouml;">
+.
+<p>foo <a href="&ouml;"></p>
+ +
+

Backslash escapes do not work in HTML attributes:

+
+
foo <a href="\*">
+.
+<p>foo <a href="\*"></p>
+ +
+
+
<a href="\"">
+.
+<p>&lt;a href=&quot;&quot;&quot;&gt;</p>
+ +
+
+

+Disallowed Raw HTML (extension)

+

GFM enables the tagfilter extension, where the following HTML tags will be +filtered when rendering HTML output:

+ +

Filtering is done by replacing the leading < with the entity &lt;. These +tags are chosen in particular as they change how HTML is interpreted in a way +unique to them (i.e. nested HTML is interpreted differently), and this is +usually undesireable in the context of other rendered Markdown content.

+

All other HTML tags are left untouched.

+
+
<strong> <title> <style> <em>
+
+<blockquote>
+  <xmp> is disallowed.  <XMP> is also disallowed.
+</blockquote>
+.
+<p><strong> &lt;title> &lt;style> <em></p>
+<blockquote>
+  &lt;xmp> is disallowed.  &lt;XMP> is also disallowed.
+</blockquote>
+ +
+
+

+Hard line breaks

+

A line break (not in a code span or HTML tag) that is preceded +by two or more spaces and does not occur at the end of a block +is parsed as a hard line break (rendered +in HTML as a <br /> tag):

+
+
foo  
+baz
+.
+<p>foo<br />
+baz</p>
+ +
+

For a more visible alternative, a backslash before the +[line ending] may be used instead of two spaces:

+
+
foo\
+baz
+.
+<p>foo<br />
+baz</p>
+ +
+

More than two spaces can be used:

+
+
foo       
+baz
+.
+<p>foo<br />
+baz</p>
+ +
+

Leading spaces at the beginning of the next line are ignored:

+
+
foo  
+     bar
+.
+<p>foo<br />
+bar</p>
+ +
+
+
foo\
+     bar
+.
+<p>foo<br />
+bar</p>
+ +
+

Line breaks can occur inside emphasis, links, and other constructs +that allow inline content:

+
+
*foo  
+bar*
+.
+<p><em>foo<br />
+bar</em></p>
+ +
+
+
*foo\
+bar*
+.
+<p><em>foo<br />
+bar</em></p>
+ +
+

Line breaks do not occur inside code spans

+
+
`code  
+span`
+.
+<p><code>code   span</code></p>
+ +
+
+
`code\
+span`
+.
+<p><code>code\ span</code></p>
+ +
+

or HTML tags:

+
+
<a href="foo  
+bar">
+.
+<p><a href="foo  
+bar"></p>
+ +
+
+
<a href="foo\
+bar">
+.
+<p><a href="foo\
+bar"></p>
+ +
+

Hard line breaks are for separating inline content within a block. +Neither syntax for hard line breaks works at the end of a paragraph or +other block element:

+
+
foo\
+.
+<p>foo\</p>
+ +
+
+
foo  
+.
+<p>foo</p>
+ +
+
+
### foo\
+.
+<h3>foo\</h3>
+ +
+
+
### foo  
+.
+<h3>foo</h3>
+ +
+

+Soft line breaks

+

A regular line break (not in a code span or HTML tag) that is not +preceded by two or more spaces or a backslash is parsed as a +softbreak. (A softbreak may be rendered in HTML either as a +[line ending] or as a space. The result will be the same in +browsers. In the examples here, a [line ending] will be used.)

+
+
foo
+baz
+.
+<p>foo
+baz</p>
+ +
+

Spaces at the end of the line and beginning of the next line are +removed:

+
+
foo 
+ baz
+.
+<p>foo
+baz</p>
+ +
+

A conforming parser may render a soft line break in HTML either as a +line break or as a space.

+

A renderer may also provide an option to render soft line breaks +as hard line breaks.

+

+Textual content

+

Any characters not given an interpretation by the above rules will +be parsed as plain textual content.

+
+
hello $.;'there
+.
+<p>hello $.;'there</p>
+ +
+
+
Foo Ï‡Ïáż†Îœ
+.
+<p>Foo Ï‡Ïáż†Îœ</p>
+ +
+

Internal spaces are preserved verbatim:

+
+
Multiple     spaces
+.
+<p>Multiple     spaces</p>
+ +
+

+GitLab Official Specification Markdown

+

Currently, only some of the GitLab-specific markdown features are +listed in this section. We will eventually add all +GitLab-specific features currently listed as supported in the +user-facing documentation for GitLab Flavored Markdown.

+

There is currently only this single top-level heading, but the +examples may be split into multiple top-level headings in the future.

+

+Footnotes

+

See +the footnotes section of the user-facing documentation for GitLab Flavored Markdown.

+
+
footnote reference tag [^fortytwo]
+
+[^fortytwo]: footnote text
+.
+<p>
+footnote reference tag
+<sup>
+<a href="#fn-fortytwo-42" id="fnref-fortytwo-42" data-footnote-ref>
+1
+</a>
+</sup>
+</p>
+<section data-footnotes>
+<ol>
+<li id="fn-fortytwo-42">
+<p>
+footnote text
+<a href="#fnref-fortytwo-42" data-footnote-backref>
+</a>
+</p>
+</li>
+</ol>
+</section>
+ +
+

+Task list items

+

See +Task lists in the GitLab Flavored Markdown documentation.

+

Task list items (checkboxes) are defined as a GitHub Flavored Markdown extension in a section above. +GitLab extends the behavior of task list items to support additional features. +Some of these features are in-progress, and should not yet be considered part of the official +GitLab Flavored Markdown specification.

+

Some of the behavior of task list items is implemented as client-side JavaScript/CSS.

+

The following are some basic examples; more examples may be added in the future.

+

Incomplete task:

+
+
- [ ] incomplete
+.
+<ul>
+<li>
+<task-button/>
+<input type="checkbox" disabled/>
+incomplete
+</li>
+</ul>
+ +
+

Completed task:

+
+
- [x] completed
+.
+<ul>
+<li>
+<task-button/>
+<input type="checkbox" checked disabled/>
+completed
+</li>
+</ul>
+ +
+

Inapplicable task:

+
+
- [~] inapplicable
+.
+<ul>
+<li>
+<task-button/>
+<input type="checkbox" data-inapplicable disabled>
+<s>
+inapplicable
+</s>
+</li>
+</ul>
+ +
+

Inapplicable task in a "loose" list. Note that the <del> tag is not applied to the +loose text; it has strikethrough applied with CSS.

+
+
- [~] inapplicable
+
+  text in loose list
+.
+<ul>
+<li>
+<p>
+<task-button/>
+<input type="checkbox" data-inapplicable disabled>
+<s>
+inapplicable
+</s>
+</p>
+<p>
+text in loose list
+</p>
+</li>
+</ul>
+ +
+

+Front matter

+

See +Front matter in the GitLab Flavored Markdown documentation.

+

Front matter is metadata included at the beginning of a Markdown document, preceding the content. +This data can be used by static site generators like Jekyll, Hugo, and many other applications.

+

YAML front matter:

+
+
---
+title: YAML front matter
+---
+.
+<pre>
+<code>
+title: YAML front matter
+</code>
+</pre>
+ +
+

TOML front matter:

+
+
+++
+title: TOML front matter
++++
+.
+<pre>
+<code>
+title: TOML front matter
+</code>
+</pre>
+ +
+

JSON front matter:

+
+
;;;
+{
+  "title": "JSON front matter"
+}
+;;;
+.
+<pre>
+<code>
+{
+  "title": "JSON front matter"
+}
+</code>
+</pre>
+ +
+

Front matter blocks should be inserted at the top of the document:

+
+
text
+
+---
+title: YAML front matter
+---
+.
+<p>text</p>
+<hr>
+<h2>title: YAML front matter</h2>
+ +
+

Front matter block delimiters shouldn’t be preceded by space characters:

+
+
 ---
+title: YAML front matter
+---
+.
+<hr>
+<h2>title: YAML front matter</h2>
+ +
+

+Table of contents

+

See +table of contents +in the GitLab Flavored Markdown documentation.

+

A table of contents is an unordered list that links to subheadings in the document. +Add either the [[_TOC_]] or

tag on its own line. +
+
[TOC]
+
+# Heading 1
+
+## Heading 2
+.
+<nav>
+  <ul>
+    <li><a href="#heading-1">Heading 1</a></li>
+    <ul>
+      <li><a href="#heading-2">Heading 2</a></li>
+    </ul>
+  </ul>
+</nav>
+<h1>Heading 1</h1>
+<h2>Heading 2</h2>
+ +
+
+
[[_TOC_]]
+
+# Heading 1
+
+## Heading 2
+.
+<nav>
+  <ul>
+    <li><a href="#heading-1">Heading 1</a></li>
+    <ul>
+      <li><a href="#heading-2">Heading 2</a></li>
+    </ul>
+  </ul>
+</nav>
+<h1>Heading 1</h1>
+<h2>Heading 2</h2>
+ +
+

A table of contents is a block element. It should preceded and followed by a blank +line.

+
+
[[_TOC_]]
+text
+
+text
+[TOC]
+.
+<p>[[<em>TOC</em>]]text</p>
+<p>text[TOC]</p>
+ +
+

A table of contents can be indented with up to three spaces.

+
+
   [[_TOC_]]
+
+# Heading 1
+.
+<nav>
+  <ul>
+    <li><a href="#heading-1">Heading 1</a></li>
+  </ul>
+</nav>
+<h1>Heading 1</h1>
+ +
+

+GitLab Internal Extension Markdown

+

+Audio

+

See +audio in the GitLab Flavored Markdown documentation.

+

GLFM renders image elements as an audio player as long as the resource’s file extension is +one of the following supported audio extensions .mp3, .oga, .ogg, .spx, and .wav. +Audio ignore the alternative text part of an image declaration.

+
+
![audio](audio.oga "audio title")
+.
+<p><audio src="audio.oga" title="audio title"></audio></p>
+ +
+

Reference definitions work audio as well:

+
+
[audio]: audio.oga "audio title"
+
+![audio][audio]
+.
+<p><audio src="audio.oga" title="audio title"></audio></p>
+ +
+

+Video

+

See +videos in the GitLab Flavored Markdown documentation.

+

GLFM renders image elements as a video player as long as the resource’s file extension is +one of the following supported video extensions .mp4, .m4v, .mov, .webm, and .ogv. +Videos ignore the alternative text part of an image declaration.

+
+
![video](video.m4v "video title")
+.
+<p><video src="video.m4v" title="video title"></video></p>
+ +
+

Reference definitions work video as well:

+
+
[video]: video.mov "video title"
+
+![video][video]
+.
+<p><video src="video.mov" title="video title"></video></p>
+ +
+

+Markdown Preview API Request Overrides

+

This section contains examples of all controllers which use PreviewMarkdown module +and use different markdown_context_params. They exercise the various preview_markdown +endpoints via glfm_example_metadata.yml.

+

preview_markdown exercising groups API endpoint and UploadLinkFilter:

+
+
[groups-test-file](/uploads/groups-test-file)
+.
+<p><a href="groups-test-file">groups-test-file</a></p>
+ +
+

preview_markdown exercising projects API endpoint and RepositoryLinkFilter:

+
+
[projects-test-file](projects-test-file)
+.
+<p><a href="projects-test-file">projects-test-file</a></p>
+ +
+

preview_markdown exercising projects API endpoint and SnippetReferenceFilter:

+
+
This project snippet ID reference IS filtered: $88888
+.
+<p>This project snippet ID reference IS filtered: $88888</p>
+ +
+

preview_markdown exercising personal (non-project) snippets API endpoint. This is +only used by the comment field on personal snippets. It has no unique custom markdown +extension behavior, and specifically does not render snippet references via +SnippetReferenceFilter, even if the ID is valid.

+
+
This personal snippet ID reference is not filtered: $99999
+.
+<p>This personal snippet ID reference is not filtered: $99999</p>
+ +
+

preview_markdown exercising project wikis API endpoint and WikiLinkFilter:

+
+
[project-wikis-test-file](project-wikis-test-file)
+.
+<p><a href="project-wikis-test-file">project-wikis-test-file</a></p>
+ +
+

preview_markdown exercising group wikis API endpoint and WikiLinkFilter. This example +also requires an EE license enabling the group_wikis feature:

+
+
[group-wikis-test-file](group-wikis-test-file)
+.
+<p><a href="group-wikis-test-file">group-wikis-test-file</a></p>
+ +
+ +

+Appendix: A parsing strategy

+

In this appendix we describe some features of the parsing strategy +used in the CommonMark reference implementations.

+

+Overview

+

Parsing has two phases:

+
    +
  1. +

    In the first phase, lines of input are consumed and the block +structure of the document---its division into paragraphs, block quotes, +list items, and so on---is constructed. Text is assigned to these +blocks but not parsed. Link reference definitions are parsed and a +map of links is constructed.

    +
    2. +
  2. +

    In the second phase, the raw text contents of paragraphs and headings +are parsed into sequences of Markdown inline elements (strings, +code spans, links, emphasis, and so on), using the map of link +references constructed in phase 1.

    +
    3. +
+

At each point in processing, the document is represented as a tree of +blocks. The root of the tree is a document block. The document +may have any number of other blocks as children. These children +may, in turn, have other blocks as children. The last child of a block +is normally considered open, meaning that subsequent lines of input +can alter its contents. (Blocks that are not open are closed.) +Here, for example, is a possible document tree, with the open blocks +marked by arrows:

+
+
-> document
+  -> block_quote
+       paragraph
+         "Lorem ipsum dolor\nsit amet."
+    -> list (type=bullet tight=true bullet_char=-)
+         list_item
+           paragraph
+             "Qui *quodsi iracundia*"
+      -> list_item
+        -> paragraph
+             "aliquando id"
+ +
+

+Phase 1: block structure

+

Each line that is processed has an effect on this tree. The line is +analyzed and, depending on its contents, the document may be altered +in one or more of the following ways:

+
    +
  1. One or more open blocks may be closed.
    2. +
  2. One or more new blocks may be created as children of the +last open block.
    3. +
  3. Text may be added to the last (deepest) open block remaining +on the tree.
    4. +
+

Once a line has been incorporated into the tree in this way, +it can be discarded, so input can be read in a stream.

+

For each line, we follow this procedure:

+
    +
  1. +

    First we iterate through the open blocks, starting with the +root document, and descending through last children down to the last +open block. Each block imposes a condition that the line must satisfy +if the block is to remain open. For example, a block quote requires a +> character. A paragraph requires a non-blank line. +In this phase we may match all or just some of the open +blocks. But we cannot close unmatched blocks yet, because we may have a +[lazy continuation line].

    +
    2. +
  2. +

    Next, after consuming the continuation markers for existing +blocks, we look for new block starts (e.g. > for a block quote). +If we encounter a new block start, we close any blocks unmatched +in step 1 before creating the new block as a child of the last +matched block.

    +
    3. +
  3. +

    Finally, we look at the remainder of the line (after block +markers like >, list markers, and indentation have been consumed). +This is text that can be incorporated into the last open +block (a paragraph, code block, heading, or raw HTML).

    +
    4. +
+

Setext headings are formed when we see a line of a paragraph +that is a [setext heading underline].

+

Reference link definitions are detected when a paragraph is closed; +the accumulated text lines are parsed to see if they begin with +one or more reference link definitions. Any remainder becomes a +normal paragraph.

+

We can see how this works by considering how the tree above is +generated by four lines of Markdown:

+
+
> Lorem ipsum dolor
+sit amet.
+> - Qui *quodsi iracundia*
+> - aliquando id
+ +
+

At the outset, our document model is just

+
+
-> document
+ +
+

The first line of our text,

+
+
> Lorem ipsum dolor
+ +
+

causes a block_quote block to be created as a child of our +open document block, and a paragraph block as a child of +the block_quote. Then the text is added to the last open +block, the paragraph:

+
+
-> document
+  -> block_quote
+    -> paragraph
+         "Lorem ipsum dolor"
+ +
+

The next line,

+
+
sit amet.
+ +
+

is a "lazy continuation" of the open paragraph, so it gets added +to the paragraph's text:

+
+
-> document
+  -> block_quote
+    -> paragraph
+         "Lorem ipsum dolor\nsit amet."
+ +
+

The third line,

+
+
> - Qui *quodsi iracundia*
+ +
+

causes the paragraph block to be closed, and a new list block +opened as a child of the block_quote. A list_item is also +added as a child of the list, and a paragraph as a child of +the list_item. The text is then added to the new paragraph:

+
+
-> document
+  -> block_quote
+       paragraph
+         "Lorem ipsum dolor\nsit amet."
+    -> list (type=bullet tight=true bullet_char=-)
+      -> list_item
+        -> paragraph
+             "Qui *quodsi iracundia*"
+ +
+

The fourth line,

+
+
> - aliquando id
+ +
+

causes the list_item (and its child the paragraph) to be closed, +and a new list_item opened up as child of the list. A paragraph +is added as a child of the new list_item, to contain the text. +We thus obtain the final tree:

+
+
-> document
+  -> block_quote
+       paragraph
+         "Lorem ipsum dolor\nsit amet."
+    -> list (type=bullet tight=true bullet_char=-)
+         list_item
+           paragraph
+             "Qui *quodsi iracundia*"
+      -> list_item
+        -> paragraph
+             "aliquando id"
+ +
+

+Phase 2: inline structure

+

Once all of the input has been parsed, all open blocks are closed.

+

We then "walk the tree," visiting every node, and parse raw +string contents of paragraphs and headings as inlines. At this +point we have seen all the link reference definitions, so we can +resolve reference links as we go.

+
+
document
+  block_quote
+    paragraph
+      str "Lorem ipsum dolor"
+      softbreak
+      str "sit amet."
+    list (type=bullet tight=true bullet_char=-)
+      list_item
+        paragraph
+          str "Qui "
+          emph
+            str "quodsi iracundia"
+      list_item
+        paragraph
+          str "aliquando id"
+ +
+

Notice how the [line ending] in the first paragraph has +been parsed as a softbreak, and the asterisks in the first list item +have become an emph.

+

+An algorithm for parsing nested emphasis and links

+

By far the trickiest part of inline parsing is handling emphasis, +strong emphasis, links, and images. This is done using the following +algorithm.

+

When we're parsing inlines and we hit either

+ +

we insert a text node with these symbols as its literal content, and we +add a pointer to this text node to the delimiter stack.

+

The [delimiter stack] is a doubly linked list. Each +element contains a pointer to a text node, plus information about

+ +

When we hit a ] character, we call the look for link or image +procedure (see below).

+

When we hit the end of the input, we call the process emphasis +procedure (see below), with stack_bottom = NULL.

+

+look for link or image +

+

Starting at the top of the delimiter stack, we look backwards +through the stack for an opening [ or ![ delimiter.

+ +

+process emphasis +

+

Parameter stack_bottom sets a lower bound to how far we +descend in the [delimiter stack]. If it is NULL, we can +go all the way to the bottom. Otherwise, we stop before +visiting stack_bottom.

+

Let current_position point to the element on the [delimiter stack] +just above stack_bottom (or the first element if stack_bottom +is NULL).

+

We keep track of the openers_bottom for each delimiter +type (*, _) and each length of the closing delimiter run +(modulo 3). Initialize this to stack_bottom.

+

Then we repeat the following until we run out of potential +closers:

+ +

After we're done, we remove all delimiters above stack_bottom from the +delimiter stack.

diff --git a/lib/api/entities/user_with_admin.rb b/lib/api/entities/user_with_admin.rb index f9c1a646a4f..53fef7a46e2 100644 --- a/lib/api/entities/user_with_admin.rb +++ b/lib/api/entities/user_with_admin.rb @@ -6,6 +6,7 @@ module API expose :admin?, as: :is_admin expose :note expose :namespace_id + expose :created_by, with: UserBasic end end end diff --git a/lib/api/helpers/projects_helpers.rb b/lib/api/helpers/projects_helpers.rb index 716db9a87b0..9839828a5b4 100644 --- a/lib/api/helpers/projects_helpers.rb +++ b/lib/api/helpers/projects_helpers.rb @@ -59,7 +59,7 @@ module API optional :only_allow_merge_if_all_discussions_are_resolved, type: Boolean, desc: 'Only allow to merge if all threads are resolved' optional :tag_list, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, desc: 'Deprecated: Use :topics instead' optional :topics, type: Array[String], coerce_with: ::API::Validations::Types::CommaSeparatedToArray.coerce, desc: 'The list of topics for a project' - optional :avatar, type: ::API::Validations::Types::WorkhorseFile, desc: 'Avatar image for project' + optional :avatar, type: ::API::Validations::Types::WorkhorseFile, desc: 'Avatar image for project', documentation: { type: 'file' } optional :printing_merge_request_link_enabled, type: Boolean, desc: 'Show link to create/view merge request when pushing from the command line' optional :merge_method, type: String, values: %w(ff rebase_merge merge), desc: 'The merge method used when merging merge requests' optional :suggestion_commit_message, type: String, desc: 'The commit message used to apply merge request suggestions' @@ -73,7 +73,7 @@ module API optional :repository_storage, type: String, desc: 'Which storage shard the repository is on. Available only to admins' optional :packages_enabled, type: Boolean, desc: 'Enable project packages feature' optional :squash_option, type: String, values: %w(never always default_on default_off), desc: 'Squash default for project. One of `never`, `always`, `default_on`, or `default_off`.' - optional :mr_default_target_self, Boolean, desc: 'Merge requests of this forked project targets itself by default' + optional :mr_default_target_self, type: Boolean, desc: 'Merge requests of this forked project targets itself by default' end params :optional_project_params_ee do diff --git a/lib/api/project_export.rb b/lib/api/project_export.rb index d610b5e4f95..29fdfe45566 100644 --- a/lib/api/project_export.rb +++ b/lib/api/project_export.rb @@ -46,7 +46,8 @@ module API optional :description, type: String, desc: 'Override the project description' optional :upload, type: Hash do optional :url, type: String, desc: 'The URL to upload the project' - optional :http_method, type: String, default: 'PUT', desc: 'HTTP method to upload the exported project' + optional :http_method, type: String, default: 'PUT', values: %w[PUT POST], + desc: 'HTTP method to upload the exported project' end end post ':id/export' do diff --git a/lib/api/project_import.rb b/lib/api/project_import.rb index 7a66044c5b6..0da8c1ecedd 100644 --- a/lib/api/project_import.rb +++ b/lib/api/project_import.rb @@ -55,7 +55,7 @@ module API params do requires :path, type: String, desc: 'The new project path and name' - requires :file, type: ::API::Validations::Types::WorkhorseFile, desc: 'The project export file to be imported' + requires :file, type: ::API::Validations::Types::WorkhorseFile, desc: 'The project export file to be imported', documentation: { type: 'file' } optional :name, type: String, desc: 'The name of the project to be imported. Defaults to the path of the project if not provided.' optional :namespace, type: String, desc: "The ID or name of the namespace that the project will be imported into. Defaults to the current user's namespace." optional :overwrite, type: Boolean, default: false, desc: 'If there is a project in the same namespace and with the same name overwrite it' diff --git a/lib/gitlab/gon_helper.rb b/lib/gitlab/gon_helper.rb index 814040d29e1..bdb7484f3d6 100644 --- a/lib/gitlab/gon_helper.rb +++ b/lib/gitlab/gon_helper.rb @@ -33,6 +33,7 @@ module Gitlab gon.sprite_file_icons = IconsHelper.sprite_file_icons_path gon.emoji_sprites_css_path = ActionController::Base.helpers.stylesheet_path('emoji_sprites') gon.select2_css_path = ActionController::Base.helpers.stylesheet_path('lazy_bundles/select2.css') + gon.gridstack_css_path = ActionController::Base.helpers.stylesheet_path('lazy_bundles/gridstack.css') gon.test_env = Rails.env.test? gon.disable_animations = Gitlab.config.gitlab['disable_animations'] gon.suggested_label_colors = LabelsHelper.suggested_colors diff --git a/lib/tasks/gitlab/tw/codeowners.rake b/lib/tasks/gitlab/tw/codeowners.rake index 5b2d538f709..fd9c7114979 100644 --- a/lib/tasks/gitlab/tw/codeowners.rake +++ b/lib/tasks/gitlab/tw/codeowners.rake @@ -7,10 +7,10 @@ namespace :tw do task :codeowners do CodeOwnerRule = Struct.new(:category, :writer) DocumentOwnerMapping = Struct.new(:path, :writer) do - def writer_owns_all_pages?(mappings) - mappings - .select { |mapping| mapping.directory == directory } - .all? { |mapping| mapping.writer == writer } + def writer_owns_directory?(mappings) + dir_mappings = mappings.select { |mapping| mapping.directory == directory } + + dir_mappings.count { |mapping| mapping.writer == writer } / dir_mappings.length.to_f > 0.5 end def directory @@ -115,14 +115,14 @@ namespace :tw do deduplicated_mappings = Set.new mappings.each do |mapping| - if mapping.writer_owns_all_pages?(mappings) + if mapping.writer_owns_directory?(mappings) deduplicated_mappings.add("#{mapping.directory}/ #{mapping.writer}") else deduplicated_mappings.add("#{mapping.path} #{mapping.writer}") end end - deduplicated_mappings.each { |mapping| puts mapping } + deduplicated_mappings.sort.each { |mapping| puts mapping } if errors.present? puts "-----" diff --git a/locale/gitlab.pot b/locale/gitlab.pot index a4ac7b42231..003f529c90d 100644 --- a/locale/gitlab.pot +++ b/locale/gitlab.pot @@ -30800,9 +30800,15 @@ msgstr "" msgid "Product Analytics" msgstr "" +msgid "ProductAnalytics|Audience" +msgstr "" + msgid "ProductAnalytics|There is no data for this type of chart currently. Please see the Setup tab if you have not configured the product analytics tool already." msgstr "" +msgid "ProductAnalytics|Widgets content" +msgstr "" + msgid "Productivity" msgstr "" diff --git a/package.json b/package.json index bfeb065cfd1..12139224df6 100644 --- a/package.json +++ b/package.json @@ -127,6 +127,7 @@ "fuzzaldrin-plus": "^0.6.0", "graphql": "^15.7.2", "graphql-tag": "^2.11.0", + "gridstack": "^7.0.0", "highlight.js": "^11.5.1", "immer": "^9.0.15", "ipaddr.js": "^1.9.1", diff --git a/scripts/lib/glfm/constants.rb b/scripts/lib/glfm/constants.rb index 36207f7e735..352bd867a61 100644 --- a/scripts/lib/glfm/constants.rb +++ b/scripts/lib/glfm/constants.rb @@ -24,6 +24,7 @@ module Glfm specification_input_glfm_path.join('glfm_example_metadata.yml') GLFM_EXAMPLE_NORMALIZATIONS_YML_PATH = specification_input_glfm_path.join('glfm_example_normalizations.yml') GLFM_SPEC_TXT_PATH = specification_path.join('output/spec.txt') + GLFM_SPEC_HTML_PATH = specification_path.join('output/spec.html') # Example Snapshot (ES) files es_fixtures_path = File.expand_path("../../../glfm_specification/example_snapshots", __dir__) diff --git a/scripts/lib/glfm/render_static_html.rb b/scripts/lib/glfm/render_static_html.rb index 040c62c42f2..6af73cd845d 100644 --- a/scripts/lib/glfm/render_static_html.rb +++ b/scripts/lib/glfm/render_static_html.rb @@ -25,7 +25,7 @@ require_relative 'shared' # It is intended to be invoked as a helper subprocess from the `update_example_snapshots.rb` # script class. It's not intended to be run or used directly. This usage is also reinforced # by not naming the file with a `_spec.rb` ending. -RSpec.describe 'Render Static HTML', :api, type: :request do # rubocop:disable RSpec/TopLevelDescribePath +RSpec.describe 'Render Static HTML', :api, type: :request do include Glfm::Constants include Glfm::Shared @@ -34,7 +34,12 @@ RSpec.describe 'Render Static HTML', :api, type: :request do # rubocop:disable R it do markdown_hash = YAML.safe_load(File.open(ENV.fetch('INPUT_MARKDOWN_YML_PATH')), symbolize_names: true) - metadata_hash = YAML.safe_load(File.open(ENV.fetch('INPUT_METADATA_YML_PATH')), symbolize_names: true) || {} + metadata_hash = + if input_metadata_yml_path = ENV['INPUT_METADATA_YML_PATH'] + YAML.safe_load(File.open(input_metadata_yml_path), symbolize_names: true) || {} + else + {} + end # NOTE: We cannot parallelize this loop like the Javascript WYSIWYG example generation does, # because the rspec `post` API cannot be parallized (it is not thread-safe, it can't find diff --git a/scripts/lib/glfm/update_example_snapshots.rb b/scripts/lib/glfm/update_example_snapshots.rb index e502990b03f..9075260e748 100644 --- a/scripts/lib/glfm/update_example_snapshots.rb +++ b/scripts/lib/glfm/update_example_snapshots.rb @@ -10,7 +10,7 @@ require_relative 'constants' require_relative 'shared' require_relative 'parse_examples' -# IMPORTANT NOTE: See https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/ +# IMPORTANT NOTE: See https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/#update-example-snapshotsrb-script # for details on the implementation and usage of this script. This developers guide # contains diagrams and documentation of this script, # including explanations and examples of all files it reads and writes. @@ -30,8 +30,6 @@ module Glfm def process(skip_static_and_wysiwyg: false) output('Updating example snapshots...') - output('(Skipping static HTML generation)') if skip_static_and_wysiwyg - output("Reading #{GLFM_SPEC_TXT_PATH}...") glfm_spec_txt_lines = File.open(GLFM_SPEC_TXT_PATH).readlines @@ -266,7 +264,7 @@ module Glfm # NOTE 2: We run this as an RSpec process, for the same reasons we run via Jest process below: # because that's the easiest way to ensure a reliable, fully-configured environment in which - # to execute the markdown-generation logic. Also, in the static/backend case, Rspec + # to execute the markdown-processing logic. Also, in the static/backend case, Rspec # provides the easiest and most reliable way to generate example data via Factorybot # creation of stable model records. This ensures consistent snapshot values across # machines/environments. diff --git a/scripts/lib/glfm/update_specification.rb b/scripts/lib/glfm/update_specification.rb index 450963e46e9..c7264547e44 100644 --- a/scripts/lib/glfm/update_specification.rb +++ b/scripts/lib/glfm/update_specification.rb @@ -2,19 +2,38 @@ require 'fileutils' require 'open-uri' require 'pathname' +require 'tempfile' +require 'yaml' require_relative 'constants' require_relative 'shared' +# IMPORTANT NOTE: See https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/#update-specificationrb-script +# for details on the implementation and usage of this script. This developers guide +# contains diagrams and documentation of this script, +# including explanations and examples of all files it reads and writes. +# +# Also note that this script is intentionally written in a pure-functional (not OO) style, +# with no dependencies on Rails or the GitLab libraries. These choices are intended to make +# it faster and easier to test and debug. module Glfm class UpdateSpecification include Constants include Shared - def process + def process(skip_spec_html_generation: false) output('Updating specification...') + ghfm_spec_lines = load_ghfm_spec glfm_spec_txt_string = build_glfm_spec_txt(ghfm_spec_lines) write_glfm_spec_txt(glfm_spec_txt_string) + + if skip_spec_html_generation + output("Skipping GLFM spec.html generation...") + return + end + + glfm_spec_html_string = generate_glfm_spec_html(glfm_spec_txt_string) + write_glfm_spec_html(glfm_spec_html_string) end private @@ -43,7 +62,11 @@ module Glfm def update_ghfm_spec_md output("Downloading #{GHFM_SPEC_TXT_URI}...") - ghfm_spec_txt_uri_io = URI.parse(GHFM_SPEC_TXT_URI).open + # NOTE: We use `URI.parse` to avoid RuboCop warning "Security/Open", + # even though we are using a trusted URI from a string literal constant. + # See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98656#note_1138595002 for details. + ghfm_spec_txt_uri_parsed = URI.parse(GHFM_SPEC_TXT_URI) + ghfm_spec_txt_uri_io = ghfm_spec_txt_uri_parsed.open # Read IO stream into an array of lines for easy processing later ghfm_spec_lines = ghfm_spec_txt_uri_io.readlines @@ -132,5 +155,49 @@ module Glfm FileUtils.mkdir_p(Pathname.new(GLFM_SPEC_TXT_PATH).dirname) write_file(GLFM_SPEC_TXT_PATH, glfm_spec_txt_string) end + + def generate_glfm_spec_html(glfm_spec_txt_string) + output("Generating spec.html from spec.txt markdown...") + + input_markdown_yml_string = <<~MARKDOWN + --- + spec_txt: | + #{glfm_spec_txt_string.gsub(/^/, ' ')} + MARKDOWN + + # NOTE: We must copy the input YAML file used by the `render_static_html.rb` + # to a separate temporary file in order for the script to read them, because it is run in + # a separate subprocess, and during unit testing we are unable to substitute the mock + # StringIO when reading the input files in the subprocess. + ENV['INPUT_MARKDOWN_YML_PATH'] = Dir::Tmpname.create(MARKDOWN_TEMPFILE_BASENAME) do |path| + write_file(path, input_markdown_yml_string) + end + + # NOTE 1: We shell out to perform the conversion of markdown to static HTML by invoking a + # separate subprocess. This allows us to avoid using the Rails API or environment in this + # script, which makes developing and running the unit tests for this script much faster, + # because they can use 'fast_spec_helper' which does not require the entire Rails environment. + + # NOTE 2: We run this as an RSpec process, for the same reasons we run via Jest process below: + # because that's the easiest way to ensure a reliable, fully-configured environment in which + # to execute the markdown-processing logic. Also, in the static/backend case. + + # Dir::Tmpname.create requires a block, but we are using the non-block form to get the path + # via the return value, so we pass an empty block to avoid an error. + static_html_tempfile_path = Dir::Tmpname.create(STATIC_HTML_TEMPFILE_BASENAME) {} + ENV['OUTPUT_STATIC_HTML_TEMPFILE_PATH'] = static_html_tempfile_path + + cmd = %(bin/rspec #{__dir__}/render_static_html.rb) + run_external_cmd(cmd) + + output("Reading generated spec.html from tempfile #{static_html_tempfile_path}...") + YAML.safe_load(File.open(static_html_tempfile_path), symbolize_names: true).fetch(:spec_txt) + end + + def write_glfm_spec_html(glfm_spec_html_string) + output("Writing #{GLFM_SPEC_TXT_PATH}...") + FileUtils.mkdir_p(Pathname.new(GLFM_SPEC_HTML_PATH).dirname) + write_file(GLFM_SPEC_HTML_PATH, "#{glfm_spec_html_string}\n") + end end end diff --git a/spec/mailers/emails/profile_spec.rb b/spec/mailers/emails/profile_spec.rb index 073d8aee842..767eddb7f98 100644 --- a/spec/mailers/emails/profile_spec.rb +++ b/spec/mailers/emails/profile_spec.rb @@ -404,7 +404,7 @@ RSpec.describe Emails::Profile do end it 'includes a link to the change password documentation' do - is_expected.to have_body_text 'https://docs.gitlab.com/ee/user/profile/#changing-your-password' + is_expected.to have_body_text 'https://docs.gitlab.com/ee/user/profile/user_passwords.html#change-your-password' end it 'mentions two factor authentication when two factor is not enabled' do @@ -454,7 +454,7 @@ RSpec.describe Emails::Profile do end it 'includes a link to the change password documentation' do - is_expected.to have_body_text 'https://docs.gitlab.com/ee/user/profile/#changing-your-password' + is_expected.to have_body_text 'https://docs.gitlab.com/ee/user/profile/user_passwords.html#change-your-password' end end diff --git a/spec/requests/api/users_spec.rb b/spec/requests/api/users_spec.rb index 7acbd12cae9..1b0a27e78e3 100644 --- a/spec/requests/api/users_spec.rb +++ b/spec/requests/api/users_spec.rb @@ -165,6 +165,7 @@ RSpec.describe API::Users do expect(json_response.first).not_to have_key('note') expect(json_response.first).not_to have_key('namespace_id') + expect(json_response.first).not_to have_key('created_by') end end @@ -175,6 +176,7 @@ RSpec.describe API::Users do expect(json_response.first).not_to have_key('note') expect(json_response.first).not_to have_key('namespace_id') + expect(json_response.first).not_to have_key('created_by') end end @@ -186,6 +188,26 @@ RSpec.describe API::Users do expect(json_response.first).to have_key('note') expect(json_response.first['note']).to eq '2018-11-05 | 2FA removed | user requested | www.gitlab.com' end + + context 'with `created_by` details' do + it 'has created_by as nil with a self-registered account' do + get api("/users", admin), params: { username: user.username } + + expect(response).to have_gitlab_http_status(:success) + expect(json_response.first).to have_key('created_by') + expect(json_response.first['created_by']).to eq(nil) + end + + it 'is created_by a user and has those details' do + created = create(:user, created_by_id: user.id) + + get api("/users", admin), params: { username: created.username } + + expect(response).to have_gitlab_http_status(:success) + expect(json_response.first['created_by'].symbolize_keys) + .to eq(API::Entities::UserBasic.new(user).as_json) + end + end end context 'N+1 queries' do diff --git a/spec/scripts/lib/glfm/update_example_snapshots_spec.rb b/spec/scripts/lib/glfm/update_example_snapshots_spec.rb index 04f6c455e03..c97226c1a2d 100644 --- a/spec/scripts/lib/glfm/update_example_snapshots_spec.rb +++ b/spec/scripts/lib/glfm/update_example_snapshots_spec.rb @@ -2,8 +2,8 @@ require 'fast_spec_helper' require_relative '../../../../scripts/lib/glfm/update_example_snapshots' -# IMPORTANT NOTE: See https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/ -# for details on the implementation and usage of the `update_example_snapshots` script being tested. +# IMPORTANT NOTE: See https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/#update-example-snapshotsrb-script +# for details on the implementation and usage of the `update_example_snapshots.rb` script being tested. # This developers guide contains diagrams and documentation of the script, # including explanations and examples of all files it reads and writes. # @@ -16,11 +16,11 @@ require_relative '../../../../scripts/lib/glfm/update_example_snapshots' # which runs a jest test environment. This results in each full run of the script # taking between 30-60 seconds. The majority of this is spent loading the Rails environment. # -# However, only the `writing html.yml and prosemirror_json.yml` context is used -# to test these slow sub-processes, and it only contains a single example. +# However, only the `with full processing of static and WYSIWYG HTML` context is used +# to test these slow sub-processes, and it only contains two examples. # # All other tests currently in the file pass the `skip_static_and_wysiwyg: true` -# flag to `#process`, which skips the slow sub-processes. All of these tests +# flag to `#process`, which skips the slow sub-processes. All of these other tests # should run in sub-second time when the Spring pre-loader is used. This allows # logic which is not directly related to the slow sub-processes to be TDD'd with a # very rapid feedback cycle. diff --git a/spec/scripts/lib/glfm/update_specification_spec.rb b/spec/scripts/lib/glfm/update_specification_spec.rb index d13cc3f19eb..852b2b580e6 100644 --- a/spec/scripts/lib/glfm/update_specification_spec.rb +++ b/spec/scripts/lib/glfm/update_specification_spec.rb @@ -4,12 +4,35 @@ require 'fast_spec_helper' require_relative '../../../../scripts/lib/glfm/update_specification' require_relative '../../../support/helpers/next_instance_of' +# IMPORTANT NOTE: See https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/#update-specificationrb-script +# for details on the implementation and usage of the `update_specification.rb` script being tested. +# This developers guide contains diagrams and documentation of the script, +# including explanations and examples of all files it reads and writes. +# +# Note that this test is not structured in a traditional way, with multiple examples +# to cover all different scenarios. Instead, the content of the stubbed test fixture +# files are crafted to cover multiple scenarios with in a single example run. +# +# This is because the invocation of the full script is slow, because it executes +# a subshell for processing, which runs a full Rails environment. +# This results in each full run of the script taking between 30-60 seconds. +# The majority of this is spent loading the Rails environment. +# +# However, only the `with generation of spec.html` context is used +# to test this slow sub-process, and it only contains one example. +# +# All other tests currently in the file pass the `skip_spec_html_generation: true` +# flag to `#process`, which skips the slow sub-process. All of these other tests +# should run in sub-second time when the Spring pre-loader is used. This allows +# logic which is not directly related to the slow sub-processes to be TDD'd with a +# very rapid feedback cycle. RSpec.describe Glfm::UpdateSpecification, '#process' do include NextInstanceOf subject { described_class.new } let(:ghfm_spec_txt_uri) { described_class::GHFM_SPEC_TXT_URI } + let(:ghfm_spec_txt_uri_parsed) { instance_double(URI::HTTPS, :ghfm_spec_txt_uri_parsed) } let(:ghfm_spec_txt_uri_io) { StringIO.new(ghfm_spec_txt_contents) } let(:ghfm_spec_md_path) { described_class::GHFM_SPEC_MD_PATH } let(:ghfm_spec_txt_local_io) { StringIO.new(ghfm_spec_txt_contents) } @@ -22,6 +45,9 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do let(:glfm_internal_extension_examples_md_io) { StringIO.new(glfm_internal_extension_examples_md_contents) } let(:glfm_spec_txt_path) { described_class::GLFM_SPEC_TXT_PATH } let(:glfm_spec_txt_io) { StringIO.new } + let(:glfm_spec_html_path) { described_class::GLFM_SPEC_HTML_PATH } + let(:glfm_spec_html_io) { StringIO.new } + let(:markdown_tempfile_io) { StringIO.new } let(:ghfm_spec_txt_contents) do <<~MARKDOWN @@ -93,9 +119,10 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do # We mock out the URI and local file IO objects with real StringIO, instead of just mock # objects. This gives better and more realistic coverage, while still avoiding # actual network and filesystem I/O during the spec run. - allow_next_instance_of(URI::HTTP) do |instance| - allow(instance).to receive(:open).and_return(ghfm_spec_txt_uri_io) - end + + # input files + allow(URI).to receive(:parse).with(ghfm_spec_txt_uri).and_return(ghfm_spec_txt_uri_parsed) + allow(ghfm_spec_txt_uri_parsed).to receive(:open).and_return(ghfm_spec_txt_uri_io) allow(File).to receive(:open).with(ghfm_spec_md_path) { ghfm_spec_txt_local_io } allow(File).to receive(:open).with(glfm_intro_md_path) { glfm_intro_md_io } allow(File).to receive(:open).with(glfm_official_specification_examples_md_path) do @@ -104,7 +131,21 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do allow(File).to receive(:open).with(glfm_internal_extension_examples_md_path) do glfm_internal_extension_examples_md_io end + + # output files allow(File).to receive(:open).with(glfm_spec_txt_path, 'w') { glfm_spec_txt_io } + allow(File).to receive(:open).with(glfm_spec_html_path, 'w') { glfm_spec_html_io } + + # Allow normal opening of Tempfile files created during script execution. + tempfile_basenames = [ + described_class::MARKDOWN_TEMPFILE_BASENAME[0], + described_class::STATIC_HTML_TEMPFILE_BASENAME[0] + ].join('|') + # NOTE: This approach with a single regex seems to be the only way this can work. If you + # attempt to have multiple `allow...and_call_original` with `any_args`, the mocked + # parameter matching will fail to match the second one. + tempfiles_regex = /(#{tempfile_basenames})/ + allow(File).to receive(:open).with(tempfiles_regex, any_args).and_call_original # Prevent console output when running tests allow(subject).to receive(:output) @@ -115,7 +156,7 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do it 'does not download' do expect(URI).not_to receive(:parse).with(ghfm_spec_txt_uri) - subject.process + subject.process(skip_spec_html_generation: true) expect(reread_io(ghfm_spec_txt_local_io)).to eq(ghfm_spec_txt_contents) end @@ -131,7 +172,7 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do context 'with success' do it 'downloads and saves' do - subject.process + subject.process(skip_spec_html_generation: true) expect(reread_io(ghfm_spec_txt_local_io)).to eq(ghfm_spec_txt_contents) end @@ -149,7 +190,9 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do end it 'raises an error' do - expect { subject.process }.to raise_error /version mismatch.*expected.*29.*got.*30/i + expect do + subject.process(skip_spec_html_generation: true) + end.to raise_error /version mismatch.*expected.*29.*got.*30/i end end @@ -157,7 +200,7 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do let(:ghfm_spec_txt_contents) { '' } it 'raises an error if lines cannot be read' do - expect { subject.process }.to raise_error /unable to read lines/i + expect { subject.process(skip_spec_html_generation: true) }.to raise_error /unable to read lines/i end end @@ -167,7 +210,7 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do end it 'raises an error if file is blank' do - expect { subject.process }.to raise_error /unable to read string/i + expect { subject.process(skip_spec_html_generation: true) }.to raise_error /unable to read string/i end end end @@ -178,7 +221,7 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do let(:glfm_contents) { reread_io(glfm_spec_txt_io) } before do - subject.process + subject.process(skip_spec_html_generation: true) end it 'replaces the header text with the GitLab version' do @@ -214,6 +257,51 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do end end + describe 'writing GLFM spec.html' do + let(:glfm_contents) { reread_io(glfm_spec_html_io) } + + before do + subject.process + end + + it 'renders HTML from spec.txt', :unlimited_max_formatted_output_length do + expected = <<~HTML +
+ 
title: GitLab Flavored Markdown (GLFM) Spec
+        version: alpha
+ +
+

+ Introduction

+

+ What is GitLab Flavored Markdown?

+

Intro text about GitLab Flavored Markdown.

+

+ Section with Examples

+

+ Strong

+
+ 
__bold__
+        .
+        <p><strong>bold</strong></p>
+ +
+

End of last GitHub examples section.

+

+ Official Specification Section with Examples

+

Some examples.

+

+ Internal Extension Section with Examples

+

Some examples.

+ +

+ Appendix

+

Appendix text.

+ HTML + expect(glfm_contents).to be == expected + end + end + def reread_io(io) # Reset the io StringIO to the beginning position of the buffer io.seek(0) diff --git a/spec/services/boards/lists/list_service_spec.rb b/spec/services/boards/lists/list_service_spec.rb index 0c8a8dc7329..2d41de42581 100644 --- a/spec/services/boards/lists/list_service_spec.rb +++ b/spec/services/boards/lists/list_service_spec.rb @@ -3,13 +3,40 @@ require 'spec_helper' RSpec.describe Boards::Lists::ListService do - let(:user) { create(:user) } + let_it_be(:user) { create(:user) } + let_it_be(:group) { create(:group) } + + RSpec.shared_examples 'FOSS lists only' do + context 'when board contains a non FOSS list' do + # This scenario may happen when there used to be an EE license and user downgraded + let!(:backlog_list) { create_backlog_list(board) } + let_it_be(:milestone) { create(:milestone, group: group) } + let_it_be(:assignee_list) do + list = build(:list, board: board, user_id: user.id, list_type: List.list_types[:assignee], position: 0) + list.save!(validate: false) + list + end + + let_it_be(:milestone_list) do + list = build(:list, board: board, milestone_id: milestone.id, list_type: List.list_types[:milestone], position: 1) # rubocop:disable Layout/LineLength + list.save!(validate: false) + list + end + + it "returns only FOSS board's lists" do + # just making sure these non FOSS lists actually exist on the board + expect(board.lists.with_types([List.list_types[:assignee], List.list_types[:milestone]]).count).to eq 2 + # check that the FOSS lists are not returned from the service + expect(service.execute(board)).to match_array [backlog_list, list, board.lists.closed.first] + end + end + end describe '#execute' do let(:service) { described_class.new(parent, user) } context 'when board parent is a project' do - let_it_be(:project) { create(:project) } + let_it_be(:project) { create(:project, group: group) } let_it_be_with_reload(:board) { create(:board, project: project) } let_it_be(:label) { create(:label, project: project) } let_it_be(:list) { create(:list, board: board, label: label) } @@ -18,10 +45,10 @@ RSpec.describe Boards::Lists::ListService do let(:parent) { project } it_behaves_like 'lists list service' + it_behaves_like 'FOSS lists only' end context 'when board parent is a group' do - let_it_be(:group) { create(:group) } let_it_be_with_reload(:board) { create(:board, group: group) } let_it_be(:label) { create(:group_label, group: group) } let_it_be(:list) { create(:list, board: board, label: label) } @@ -30,6 +57,7 @@ RSpec.describe Boards::Lists::ListService do let(:parent) { group } it_behaves_like 'lists list service' + it_behaves_like 'FOSS lists only' end def create_backlog_list(board) diff --git a/spec/support/shared_examples/models/boards/listable_shared_examples.rb b/spec/support/shared_examples/models/boards/listable_shared_examples.rb index 250a4c1b1bd..ac8655a907f 100644 --- a/spec/support/shared_examples/models/boards/listable_shared_examples.rb +++ b/spec/support/shared_examples/models/boards/listable_shared_examples.rb @@ -27,14 +27,6 @@ RSpec.shared_examples 'boards listable model' do |list_factory| .to eq([list1, list3, list4, list2]) end end - - describe '.without_types' do - it 'excludes lists of given types' do - lists = described_class.without_types([:label, :closed]) - - expect(lists).to match_array([list1]) - end - end end describe '#destroyable?' do diff --git a/yarn.lock b/yarn.lock index 3e6bb447351..1a66f91e703 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6331,6 +6331,11 @@ graphql@^15.7.2: resolved "https://registry.yarnpkg.com/graphql/-/graphql-15.7.2.tgz#85ab0eeb83722977151b3feb4d631b5f2ab287ef" integrity sha512-AnnKk7hFQFmU/2I9YSQf3xw44ctnSFCfp3zE0N6W174gqe9fWG/2rKaKxROK7CcI3XtERpjEKFqts8o319Kf7A== +gridstack@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/gridstack/-/gridstack-7.0.0.tgz#2d00b28efa8d22a8b9ad2640c8ab64b494bbfdc9" + integrity sha512-iBts/PRuqg6OQvdpv7A84p3RROxzXVSKjM3SJHrdl2pdDZKmIpGo2oxjdCHv6l+SzU2EuptcHd1Rqouocwl1Cg== + gzip-size@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/gzip-size/-/gzip-size-6.0.0.tgz#065367fd50c239c0671cbcbad5be3e2eeb10e462"