Commit Graph

39 Commits

Author SHA1 Message Date
Anders Kaseorg 544bbd5398 docs: Fix capitalization mistakes.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 09:57:26 -07:00
Alya Abbott 279f7b1c8d user docs: Create separate "Code blocks" user documentation page.
* Move the extended documentation of code blocks to a separate page.
* Merge "code playgrounds" documentation to be a section of that page.
* Document copy widget on code blocks.
* This commit changes how we refer to "```python" type syntax for code
  blocks. Instead of being called a syntax highlighting label, this is
  now referred to as a "language tag", since it serves both syntax
  highlighting and playgrounds.
* Remap all the links.
* Advertise this new page in various places that previously did not have a link.
2021-05-05 16:11:21 -07:00
Sumanth V Rao a40fe26586 help: Document playgrounds on /help, /features and /for/open-source.
Linked the Help Center document in places like
    - zulip.yaml (/events, /register/, realm/playgrounds,
                  /realm/playgrounds/{playground_id})
    - /help/format-your-message-using-markdown (Linked to make
      users reading the markdown code block style, aware of this
      feature)
    - /templates/settings/playground_settings_admin.hbs (Linked
      as a reference to read more about playgrounds before
      configuring one)

Also showcase the feature on /features and /for/open-source.
2021-05-04 12:19:01 -07:00
m-e-l-u-h-a-n 2699048208 markdown: Extend user mention syntax to support user_id for mentioning.
Extend our markdown system to support mentioning of users
by id also. Following these changes, it would be possible
to mention users with @**|user_id** and silently mention
using @_**|user_id**.

Main intention for extending the mention syntax is to make
it convenient for bots to mention a users using their ids. It
is to be noted that previous syntax are also supported.

Documentation tweaked by tabbott for better readability.

The changes were tested manually in development server, and also
by adding some new backend and frontend tests.

Fixes: #17487.
2021-03-25 00:44:56 -07:00
Abhijeet Prasad Bodas 9223dced3b refactor: Rename filter to linkifier in frontend code and docs.
This only leaves `page_params.realm_filters`, which
will be changed in further commits along with the
API change.
2021-03-15 11:19:59 -07:00
Signior-X 05140a6e20 docs: Replace A icon with help in format using markdown.
In the format-your-message-using-markdown, in the in-help
help section, the A icon is replace by help button. This
updates the docs.
2021-02-08 17:29:03 -08:00
gr455 a8511bc710 docs: Add alt text to images
Add alt text to images in docs roughly stating the contents of the
image.
2020-09-04 12:56:07 -07:00
Anders Kaseorg c155403884 docs: Fix various capitalization errors.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 10:25:52 -07:00
Rohitt Vashishtha 3d0a5d28f2 timestamp: Update docs to advertise new syntax and other time formats. 2020-07-06 15:53:56 -07:00
Rohitt Vashishtha bda2e1c5a7 markdown-timestamp: Document the syntax in /help pages.
We add a separate page to advertise this feature for communities
with people in multiple timezones.
2020-06-16 16:44:39 -07:00
Sara Gulotta 1cb040647b markdown: Add support for spoilers.
This adds support for a "spoiler" syntax in Zulip's markdown, which
can be used to hide content that one doesn't want to be immediately
visible without a click.

We use our own spoiler block syntax inspired by Zulip's existing quote
and math block markdown extensions, rather than requiring a token on
every line, as is present in some other markdown spoiler
implementations.

Fixes #5802.

Co-authored-by: Dylan Nugent <dylnuge@gmail.com>
2020-06-16 16:14:10 -07:00
Tim Abbott 7b8ba5ebd9 docs: Update most remaining references to zulipchat.com.
In some cases, the cleanest tweak is to replace references to the
domain with Zulip Cloud, the product.
2020-06-08 18:10:45 -07:00
Tim Abbott 8f57ec80f6 help: Add KaTeX links explaining how our LaTeX formatting works.
Also improve the headings for it.

Fixes #14568.
2020-04-13 15:55:39 -07:00
Rohitt Vashishtha f9caf522f0 markdown: Allow setting a default language for code blocks.
This adds a new realm setting: default_code_block_language.

This PR also adds a new widget to specify a language, which
behaves somewhat differently from other widgets of the same
kind; instead of exposing methods to the whole module, we
just create a single IIFE that handles all the interactions
with the DOM for the widget.

We also move the code for remapping languages to format_code
function since we want to preserve the original language to
decide if we override it using default_code_clock_language.

Fixes #14404.
2020-04-09 16:02:02 -07:00
Anders Kaseorg 7ff9b22500 docs: Convert many http URLs to https.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-26 21:35:32 -07:00
Rishi Gupta bc220aefdf help: Document topic links. 2019-08-02 16:33:27 -07:00
Rishi Gupta 17528e4ee9 help: Add create-a-poll.md. 2019-04-02 23:09:36 -07:00
Rishi Gupta 1871d00bb2 help: Update at-mention-a-user to include user groups.
Also changes the terminology for this feature from at-mention to
mention.
2019-02-28 17:11:27 -08:00
Rishi Gupta ddad11c43a help: Add silent mentions to format-your-messages-using-markdown. 2019-02-28 14:48:07 -08:00
Rishi Gupta 2454eff51d help: Rename and update at-mention-a-team-member. 2019-02-13 18:03:22 -08:00
Rishi Gupta 7acd640f6a user docs: Update format-your-messages-using-markdown.
I used line-height: 22px and font-size: 16px in .message-content to take the
screenshots. Requires some additional fiddling for the LaTeX picture, inline
code block, and maybe a few others.
2018-09-19 17:09:28 -07:00
Shubham Padia e276006d8c help: Replace dead link to function support wiki in KaTex.
Fixes #10091.
`https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX` has
been moved from the wiki to the docs at
https://khan.github.io/KaTeX/docs/supported.html in
https://github.com/Khan/KaTeX/pull/1484.
2018-07-28 08:33:59 -07:00
Tim Abbott 23c4a25041 help: Fix a misplaced period. 2018-05-21 14:47:11 -07:00
Weronika Grzybowska 1f52eea0e4 user docs: Document auto-numbering of ordered lists.
Fixes #8246
2018-03-01 12:05:31 -08:00
rht 89afd0da22 Standardize the description of icon-vector-cog at navbar.
While humans can disambiguate 'upper right' and 'top right' to one area,
it might help with any machine reading comprehension task by choosing a
more regular wording.
2017-08-01 15:30:37 -07:00
Cynthia Lin 8211e19074 user docs: Update *Format your messages using Markdown* with UI changes. 2017-05-22 18:35:22 -07:00
Cynthia Lin eb472411ce user docs: Document status messages in Message formatting docs.
Removes *Send a status message*. Fixes #4522.
2017-05-22 18:35:22 -07:00
Cynthia Lin 0e6815fbf6 user docs: Document nested list bullets.
Fixes #4456
2017-04-17 21:51:14 -07:00
Yago González 34a9e1ae11 markdown: Add TeX typesetting support.
Co-authored-by: Reid Barton <rwbarton@gmail.com>

Fixes #2056.
2017-03-21 16:40:00 -07:00
Yago González 0c6251e58d docs: Add reference to tilde-fenced code blocks. 2017-03-21 13:58:40 -07:00
Cynthia Lin 8241f7b40b user docs: Update *Format your message using markdown* with Pygments.
Fixes #4081
2017-03-18 20:48:01 -07:00
synicalsyntax 7ba62c0e79 docs: Conform *Format your message using Markdown* to style guidelines. 2017-01-28 16:03:00 -08:00
Tim Abbott e2533cac7d docs: Clean up message formatting duplication. 2017-01-06 18:32:36 -08:00
synicalsyntax 9d09ab11a9 docs: Replace images with FontAwesome icons. 2017-01-05 16:43:00 -08:00
Tim Abbott 25f083a284 help: Wrap a bunch of very long lines.
Now there are no lines longer than 140 characters here.
2017-01-05 14:45:31 -08:00
KingxBanana 06374f004a Update format-your-message-using-markdown.md
- Fixed typo: "test" -> "text"
- Changed line 75 a bit
- Removed a `"` that was wrongly placed
- Changed an if sentence to make it grammatically correct
- Fixed line 85
2016-12-28 17:18:12 -08:00
K.Kanakhin a57752d158 help-documentation: Fix links in user help documentation 2016-12-19 08:31:39 -08:00
K.Kanakhin b0816dff73 help-documentation: Fix typos in help documentation.
Fixes #2639
2016-12-16 09:04:04 -08:00
Rishi Gupta a5add3dfb6 user guides: Synchronize names of articles with names of links. 2016-12-14 15:40:48 -08:00